Provide Readme for each pom-file

[nonrtric.git] / policy-agent / docs / api.yaml

diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml
index f42c3e0..ec9bbce 100644 (file)
--- a/policy-agent/docs/api.yaml
+++ b/policy-agent/docs/api.yaml
@@ -26,19 +26,22 @@ paths:
       parameters:
         - name: ric
           in: query
-          description: ric
+          description: The name of the Near-RT RIC to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
         - name: service
           in: query
-          description: service
+          description: The name of the service to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
         - name: type
           in: query
-          description: type
+          description: The name of the policy type to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policies
@@ -66,9 +69,10 @@ paths:
       parameters:
         - name: id
           in: query
-          description: id
+          description: The ID of the policy instance.
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy found
@@ -93,9 +97,10 @@ paths:
       parameters:
         - name: id
           in: query
-          description: id
+          description: The ID of the policy instance.
           required: true
           type: string
+          allowEmptyValue: false
         - in: body
           name: jsonBody
           description: jsonBody
@@ -104,19 +109,30 @@ paths:
             type: object
         - name: ric
           in: query
-          description: ric
+          description: The name of the Near-RT RIC where the policy will be created.
           required: true
           type: string
+          allowEmptyValue: false
         - name: service
           in: query
-          description: service
+          description: The name of the service creating the policy.
           required: true
           type: string
+          allowEmptyValue: false
+        - name: transient
+          in: query
+          description: If the policy is transient or not (boolean defaulted to false). A policy is transient if it will be forgotten when the service needs to reconnect to the Near-RT RIC.
+          required: false
+          type: boolean
+          default: false
+          allowEmptyValue: false
+          x-example: false
         - name: type
           in: query
-          description: type
+          description: The name of the policy type.
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy updated
@@ -149,9 +165,10 @@ paths:
       parameters:
         - name: id
           in: query
-          description: id
+          description: The ID of the policy instance.
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: OK
@@ -185,19 +202,22 @@ paths:
       parameters:
         - name: ric
           in: query
-          description: ric
+          description: The name of the Near-RT RIC to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
         - name: service
           in: query
-          description: service
+          description: The name of the service to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
         - name: type
           in: query
-          description: type
+          description: The name of the policy type to get policies for.
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy ids
@@ -225,9 +245,10 @@ paths:
       parameters:
         - name: id
           in: query
-          description: id
+          description: The ID of the policy type to get the definition for.
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy schema
@@ -253,9 +274,10 @@ paths:
       parameters:
         - name: ric
           in: query
-          description: ric
+          description: The name of the Near-RT RIC to get the definitions for.
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy schemas
@@ -283,9 +305,10 @@ paths:
       parameters:
         - name: id
           in: query
-          description: id
+          description: The ID of the policy.
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy status
@@ -311,9 +334,10 @@ paths:
       parameters:
         - name: ric
           in: query
-          description: ric
+          description: The name of the Near-RT RIC to get types for.
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: Policy type names
@@ -341,9 +365,10 @@ paths:
       parameters:
         - name: managedElementId
           in: query
-          description: managedElementId
+          description: The ID of the Managed Element
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: RIC is found
@@ -369,9 +394,10 @@ paths:
       parameters:
         - name: policyType
           in: query
-          description: policyType
+          description: The name of the policy type
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: OK
@@ -436,9 +462,10 @@ paths:
       parameters:
         - name: name
           in: query
-          description: name
+          description: The name of the service
           required: false
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: OK
@@ -465,9 +492,10 @@ paths:
       parameters:
         - name: name
           in: query
-          description: name
+          description: The name of the service
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: OK
@@ -499,9 +527,10 @@ paths:
       parameters:
         - name: name
           in: query
-          description: name
+          description: The name of the service
           required: true
           type: string
+          allowEmptyValue: false
       responses:
         '200':
           description: 'Service supervision timer refreshed, OK'
@@ -619,4 +648,3 @@ definitions:
         format: int64
         description: time since last invocation by the service
     title: ServiceStatus
-