X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=ec9bbce4541db6792c3ad677e80cbb69a8bf720d;hb=6a39814272307d0207222c9229b0d765ac062bf0;hp=8d5151e76882a20e34d01c66f0701cf82c72c871;hpb=f700867fa65c7172cee7fca229eb10f2ecdf77dd;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index 8d5151e7..ec9bbce4 100644 --- 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 @@ -64,11 +67,12 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: The ID of the policy instance. required: true type: string + allowEmptyValue: false responses: '200': description: Policy found @@ -91,11 +95,12 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + 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 @@ -135,7 +151,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -147,11 +163,12 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: The ID of the policy instance. required: true type: string + allowEmptyValue: false responses: '200': description: OK @@ -170,7 +187,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -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 @@ -281,11 +303,12 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + 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,12 +365,13 @@ paths: parameters: - name: managedElementId in: query - description: managedElementId - required: false + description: The ID of the Managed Element + required: true type: string + allowEmptyValue: false responses: '200': - description: RIC is fond + description: RIC is found schema: type: string '401': @@ -354,7 +379,7 @@ paths: '403': description: Forbidden '404': - description: RIC is not fond + description: RIC is not found schema: type: string deprecated: false @@ -362,16 +387,17 @@ paths: get: tags: - RIC Repository - summary: Query NearRT RIC information + summary: Query Near-RT RIC information operationId: getRicsUsingGET produces: - '*/*' parameters: - name: policyType in: query - description: policyType + description: The name of the policy type required: false type: string + allowEmptyValue: false responses: '200': description: OK @@ -415,7 +441,7 @@ paths: schema: type: string '400': - description: Cannot parse the ServiceRegistrationInfo + description: The ServiceRegistrationInfo is not accepted schema: type: string '401': @@ -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 @@ -487,11 +515,11 @@ paths: type: string deprecated: false /services/keepalive: - post: + put: tags: - Service registry and supervision summary: Heartbeat from a serice - operationId: keepAliveServiceUsingPOST + operationId: keepAliveServiceUsingPUT consumes: - application/json produces: @@ -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' @@ -557,7 +586,7 @@ definitions: description: 'timestamp, last modification time' ric: type: string - description: identity the target NearRT RIC + description: identity of the target Near-RT RIC service: type: string description: the name of the service owning the policy @@ -581,6 +610,9 @@ definitions: ricName: type: string description: identity of the ric + state: + type: string + description: state info title: RicInfo ServiceRegistrationInfo: type: object @@ -616,4 +648,3 @@ definitions: format: int64 description: time since last invocation by the service title: ServiceStatus -