X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=8d5151e76882a20e34d01c66f0701cf82c72c871;hb=643ba188e7c1d0c8ce097adfd94ced47b2da615e;hp=9c7d96efaec328c57d41dc274d02815ee96c683e;hpb=6a8a0d5350a77b6d1e4a8f95c0fe8fbfeef77339;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index 9c7d96ef..8d5151e7 100644 --- a/policy-agent/docs/api.yaml +++ b/policy-agent/docs/api.yaml @@ -14,317 +14,7 @@ tags: description: Ric Repository Controller - name: Service registry and supervision description: Service Controller - - name: operation-handler - description: Operation Handler - - name: web-mvc-links-handler - description: Web Mvc Links Handler paths: - /actuator: - get: - tags: - - web-mvc-links-handler - summary: links - operationId: linksUsingGET - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - responses: - '200': - description: OK - schema: - type: object - additionalProperties: - type: object - additionalProperties: - $ref: '#/definitions/Link' - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/health: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_1 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/health/**: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/info: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_2 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/logfile: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_3 - produces: - - text/plain;charset=UTF-8 - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/loggers: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_5 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - '/actuator/loggers/{name}': - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_4 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - post: - tags: - - operation-handler - summary: handle - operationId: handleUsingPOST - consumes: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - produces: - - '*/*' - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '201': - description: Created - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - /actuator/metrics: - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_7 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false - '/actuator/metrics/{requiredMetricName}': - get: - tags: - - operation-handler - summary: handle - operationId: handleUsingGET_6 - produces: - - application/vnd.spring-boot.actuator.v3+json - - application/json - - application/vnd.spring-boot.actuator.v2+json - parameters: - - in: body - name: body - description: body - required: false - schema: - type: object - additionalProperties: - type: string - responses: - '200': - description: OK - schema: - type: object - '401': - description: Unauthorized - '403': - description: Forbidden - '404': - description: Not Found - deprecated: false /policies: get: tags: @@ -425,17 +115,17 @@ paths: - name: type in: query description: type - required: true + required: false type: string responses: '200': description: Policy updated schema: - type: string + type: object '201': description: Policy created schema: - type: string + type: object '401': description: Unauthorized '403': @@ -444,10 +134,6 @@ paths: description: RIC or policy type is not found schema: type: string - '405': - description: Change is not allowed - schema: - type: string '423': description: RIC is locked schema: @@ -488,6 +174,46 @@ paths: 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: @@ -681,11 +407,13 @@ paths: $ref: '#/definitions/ServiceRegistrationInfo' responses: '200': - description: OK + description: Service updated schema: type: string '201': - description: Created + description: Service created + schema: + type: string '400': description: Cannot parse the ServiceRegistrationInfo schema: @@ -762,7 +490,7 @@ paths: post: tags: - Service registry and supervision - summary: Keep the policies alive for a service + summary: Heartbeat from a serice operationId: keepAliveServiceUsingPOST consumes: - application/json @@ -776,7 +504,7 @@ paths: type: string responses: '200': - description: Policies timeout supervision refreshed + description: 'Service supervision timer refreshed, OK' schema: type: string '201': @@ -809,19 +537,6 @@ paths: description: Not Found deprecated: false definitions: - Link: - type: object - properties: - href: - type: string - templated: - type: boolean - title: Link - 'Map«string,Link»': - type: object - title: 'Map«string,Link»' - additionalProperties: - $ref: '#/definitions/Link' Mono«ResponseEntity«object»»: type: object title: Mono«ResponseEntity«object»» @@ -869,14 +584,16 @@ definitions: title: RicInfo ServiceRegistrationInfo: type: object + required: + - serviceName properties: callbackUrl: type: string - description: callback for notifying of RIC recovery + description: callback for notifying of RIC synchronization 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 @@ -886,7 +603,7 @@ definitions: properties: callbackUrl: type: string - description: callback for notifying of RIC recovery + description: callback for notifying of RIC synchronization keepAliveIntervalSeconds: type: integer format: int64 @@ -894,7 +611,7 @@ definitions: serviceName: type: string description: identity of the service - timeSincePingSeconds: + timeSinceLastActivitySeconds: type: integer format: int64 description: time since last invocation by the service