X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=f42c3e000f455aca1dc367988d404591902f997a;hb=ee5dde3cccb64e50c02f22a5731ba0134e0d761c;hp=a2f1b57c47165200fb62f3c2cd18c6e70542c59d;hpb=5408c157fc8aca52731fcc2cc035ed9dbfcff219;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index a2f1b57c..f42c3e00 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: @@ -374,9 +64,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -401,9 +91,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string - in: body @@ -425,7 +115,7 @@ paths: - name: type in: query description: type - required: true + required: false type: string responses: '200': @@ -444,12 +134,8 @@ 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 + description: RIC is not operational schema: type: string deprecated: false @@ -461,9 +147,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -484,7 +170,47 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational + 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 @@ -555,9 +281,9 @@ paths: produces: - '*/*' parameters: - - name: instance + - name: id in: query - description: instance + description: id required: true type: string responses: @@ -616,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': @@ -628,7 +354,7 @@ paths: '403': description: Forbidden '404': - description: RIC is not fond + description: RIC is not found schema: type: string deprecated: false @@ -636,7 +362,7 @@ paths: get: tags: - RIC Repository - summary: Query NearRT RIC information + summary: Query Near-RT RIC information operationId: getRicsUsingGET produces: - '*/*' @@ -681,13 +407,15 @@ 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 + description: The ServiceRegistrationInfo is not accepted schema: type: string '401': @@ -759,11 +487,11 @@ paths: type: string deprecated: false /services/keepalive: - post: + put: tags: - Service registry and supervision - summary: Keep the policies alive for a service - operationId: keepAliveServiceUsingPOST + summary: Heartbeat from a serice + operationId: keepAliveServiceUsingPUT consumes: - application/json produces: @@ -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»» @@ -842,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 @@ -866,6 +581,9 @@ definitions: ricName: type: string description: identity of the ric + state: + type: string + description: state info title: RicInfo ServiceRegistrationInfo: type: object @@ -874,11 +592,11 @@ definitions: 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 @@ -888,7 +606,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 @@ -896,7 +614,7 @@ definitions: serviceName: type: string description: identity of the service - timeSincePingSeconds: + timeSinceLastActivitySeconds: type: integer format: int64 description: time since last invocation by the service