X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=1696dad902d1d903004522871381329188a8e8d1;hb=2753ad5396f2a037887503c550648902e66e86a3;hp=1c41d420e1e9022cc93e08c08db48884daeb137d;hpb=89e139b32a18dfffe03a25107584e9d9cfa59fda;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index 1c41d420..1696dad9 100644 --- a/policy-agent/docs/api.yaml +++ b/policy-agent/docs/api.yaml @@ -1,21 +1,21 @@ swagger: '2.0' info: - description: This page lists all the rest apis for Policy server. + description: This page lists all the rest apis for the service. version: '1.0' - title: Policy server + title: A1 Policy management service host: 'localhost:8081' basePath: / tags: - - name: operation-handler - description: Operation Handler - - name: policy-controller + - name: A1 Policy Management description: Policy Controller - - name: ric-repository-controller + - name: Health check + description: Status Controller + - name: RIC Repository description: Ric Repository Controller - - name: service-controller + - name: Service registry and supervision description: Service Controller - - name: status-controller - description: Status Controller + - name: operation-handler + description: Operation Handler - name: web-mvc-links-handler description: Web Mvc Links Handler paths: @@ -328,7 +328,7 @@ paths: /policies: get: tags: - - policy-controller + - A1 Policy Management summary: Query policies operationId: getPoliciesUsingGET produces: @@ -361,12 +361,14 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: RIC or type not found + schema: + type: string deprecated: false /policy: get: tags: - - policy-controller + - A1 Policy Management summary: Returns a policy configuration operationId: getPolicyUsingGET produces: @@ -382,20 +384,16 @@ paths: description: Policy found schema: type: object - '204': - description: Policy is not found - schema: - type: string '401': description: Unauthorized '403': description: Forbidden '404': - description: Not Found + description: Policy is not found deprecated: false put: tags: - - policy-controller + - A1 Policy Management summary: Put a policy operationId: putPolicyUsingPUT consumes: @@ -427,25 +425,33 @@ paths: - name: type in: query description: type - required: true + required: false type: string responses: '200': - description: Policy created or updated + description: Policy updated schema: - type: string + type: object '201': - description: Created + description: Policy created + schema: + type: object '401': description: Unauthorized '403': description: Forbidden '404': - description: Not Found + description: RIC or policy type is not found + schema: + type: string + '423': + description: RIC is locked + schema: + type: string deprecated: false delete: tags: - - policy-controller + - A1 Policy Management summary: Delete a policy operationId: deletePolicyUsingDELETE produces: @@ -469,11 +475,59 @@ paths: description: Unauthorized '403': description: Forbidden + '404': + description: Policy is not found + schema: + type: string + '423': + description: RIC is locked + schema: + type: string + deprecated: false + /policy_ids: + get: + tags: + - A1 Policy Management + summary: 'Query policies, only IDs returned' + operationId: getPolicyIdsUsingGET + produces: + - '*/*' + parameters: + - name: ric + in: query + description: ric + required: false + type: string + - name: service + in: query + description: service + required: false + type: string + - name: type + in: query + description: type + required: false + type: string + responses: + '200': + description: Policy ids + schema: + type: array + items: + type: string + '401': + description: Unauthorized + '403': + description: Forbidden + '404': + description: RIC or type not found + schema: + type: string deprecated: false /policy_schema: get: tags: - - policy-controller + - A1 Policy Management summary: Returns one policy type schema definition operationId: getPolicySchemaUsingGET produces: @@ -494,12 +548,14 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: RIC is not found + schema: + type: string deprecated: false /policy_schemas: get: tags: - - policy-controller + - A1 Policy Management summary: Returns policy type schema definitions operationId: getPolicySchemasUsingGET produces: @@ -522,12 +578,14 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: RIC is not found + schema: + type: string deprecated: false /policy_status: get: tags: - - policy-controller + - A1 Policy Management summary: Returns a policy status operationId: getPolicyStatusUsingGET produces: @@ -543,21 +601,19 @@ paths: description: Policy status schema: type: object - '204': - description: Policy is not found - schema: - type: string '401': description: Unauthorized '403': description: Forbidden '404': - description: Not Found + description: Policy is not found + schema: + type: string deprecated: false /policy_types: get: tags: - - policy-controller + - A1 Policy Management summary: Query policy type names operationId: getPolicyTypesUsingGET produces: @@ -580,12 +636,14 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: RIC is not found + schema: + type: string deprecated: false /ric: get: tags: - - ric-repository-controller + - RIC Repository summary: Returns the name of a RIC managing one Mananged Element operationId: getRicUsingGET produces: @@ -613,7 +671,7 @@ paths: /rics: get: tags: - - ric-repository-controller + - RIC Repository summary: Query NearRT RIC information operationId: getRicsUsingGET produces: @@ -636,12 +694,14 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: Policy type is not found + schema: + type: string deprecated: false /service: put: tags: - - service-controller + - Service registry and supervision summary: Register a service operationId: putServiceUsingPUT consumes: @@ -662,6 +722,10 @@ paths: type: string '201': description: Created + '400': + description: Cannot parse the ServiceRegistrationInfo + schema: + type: string '401': description: Unauthorized '403': @@ -672,7 +736,7 @@ paths: /services: get: tags: - - service-controller + - Service registry and supervision summary: Returns service information operationId: getServicesUsingGET produces: @@ -695,19 +759,21 @@ paths: '403': description: Forbidden '404': - description: Not Found + description: Service is not found + schema: + type: string deprecated: false delete: tags: - - service-controller + - Service registry and supervision summary: Delete a service operationId: deleteServiceUsingDELETE produces: - '*/*' parameters: - - name: serviceName + - name: name in: query - description: serviceName + description: name required: true type: string responses: @@ -716,31 +782,37 @@ paths: schema: type: string '204': - description: No Content + description: OK + schema: + type: string '401': description: Unauthorized '403': description: Forbidden + '404': + description: Service not found + schema: + type: string deprecated: false /services/keepalive: post: tags: - - service-controller - summary: Keep the poilicies alive for a service + - Service registry and supervision + summary: Heartbeat from a serice operationId: keepAliveServiceUsingPOST consumes: - application/json produces: - '*/*' parameters: - - name: serviceName + - name: name in: query - description: serviceName + description: name required: true type: string responses: '200': - description: Policies timeout supervision refreshed + description: 'Service supervision timer refreshed, OK' schema: type: string '201': @@ -755,7 +827,7 @@ paths: /status: get: tags: - - status-controller + - Health check summary: Returns status and statistics of this service operationId: getStatusUsingGET produces: @@ -786,9 +858,9 @@ definitions: title: 'Map«string,Link»' additionalProperties: $ref: '#/definitions/Link' - Mono«ResponseEntity«Void»»: + Mono«ResponseEntity«object»»: type: object - title: Mono«ResponseEntity«Void»» + title: Mono«ResponseEntity«object»» Mono«ResponseEntity«string»»: type: object title: Mono«ResponseEntity«string»» @@ -822,17 +894,19 @@ definitions: description: O1 identities for managed entities items: type: string - name: - type: string - description: identity of the ric policyTypes: type: array description: supported policy types items: type: string + ricName: + type: string + description: identity of the ric title: RicInfo ServiceRegistrationInfo: type: object + required: + - serviceName properties: callbackUrl: type: string @@ -840,7 +914,7 @@ definitions: keepAliveIntervalSeconds: type: integer format: int64 - description: keep alive interval for policies owned by the service. 0 means no timeout supervision. Polcies that are not refreshed within this time are removed + description: 'keep alive interval for the service. This is a heartbeat supervision of the service, which in regular intevals must invoke a ''keepAlive'' REST call. When a service does not invoke this call within the given time, it is considered unavailble. An unavailable service will be automatically deregistered and its policies will be deleted. Value 0 means no timeout supervision.' serviceName: type: string description: identity of the service @@ -848,6 +922,9 @@ definitions: ServiceStatus: type: object properties: + callbackUrl: + type: string + description: callback for notifying of RIC recovery keepAliveIntervalSeconds: type: integer format: int64 @@ -855,7 +932,7 @@ definitions: serviceName: type: string description: identity of the service - timeSincePingSeconds: + timeSinceLastActivitySeconds: type: integer format: int64 description: time since last invocation by the service