X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=f42c3e000f455aca1dc367988d404591902f997a;hb=a2fc486bd201e2794088c6c035426f3fac126f82;hp=8d5151e76882a20e34d01c66f0701cf82c72c871;hpb=f700867fa65c7172cee7fca229eb10f2ecdf77dd;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index 8d5151e7..f42c3e00 100644 --- a/policy-agent/docs/api.yaml +++ b/policy-agent/docs/api.yaml @@ -64,9 +64,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -91,9 +91,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string - in: body @@ -135,7 +135,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -147,9 +147,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -170,7 +170,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -281,9 +281,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -342,11 +342,11 @@ paths: - name: managedElementId in: query description: managedElementId - required: false + required: true type: string responses: '200': - description: RIC is fond + description: RIC is found schema: type: string '401': @@ -354,7 +354,7 @@ paths: '403': description: Forbidden '404': - description: RIC is not fond + description: RIC is not found schema: type: string deprecated: false @@ -362,7 +362,7 @@ paths: get: tags: - RIC Repository - summary: Query NearRT RIC information + summary: Query Near-RT RIC information operationId: getRicsUsingGET produces: - '*/*' @@ -415,7 +415,7 @@ paths: schema: type: string '400': - description: Cannot parse the ServiceRegistrationInfo + description: The ServiceRegistrationInfo is not accepted schema: type: string '401': @@ -487,11 +487,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: @@ -557,7 +557,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 +581,9 @@ definitions: ricName: type: string description: identity of the ric + state: + type: string + description: state info title: RicInfo ServiceRegistrationInfo: type: object