X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=policy-agent%2Fdocs%2Fapi.yaml;h=ec9bbce4541db6792c3ad677e80cbb69a8bf720d;hb=db477d6b9a6170f8cd135ab8b0b3e50a6a43cb10;hp=3dd78621f1dfe549f8a7dff403ef372747e67fa4;hpb=e2ac0dcf30eaf828a7c7bbd722730410f4110030;p=nonrtric.git diff --git a/policy-agent/docs/api.yaml b/policy-agent/docs/api.yaml index 3dd78621..ec9bbce4 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: @@ -336,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 @@ -374,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 @@ -401,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 @@ -414,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 @@ -445,7 +151,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -457,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 @@ -480,7 +187,7 @@ paths: schema: type: string '423': - description: RIC is locked + description: RIC is not operational schema: type: string deprecated: false @@ -495,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 @@ -535,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 @@ -563,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 @@ -591,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 @@ -621,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 @@ -651,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': @@ -664,7 +379,7 @@ paths: '403': description: Forbidden '404': - description: RIC is not fond + description: RIC is not found schema: type: string deprecated: false @@ -672,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 @@ -717,13 +433,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': @@ -744,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 @@ -773,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 @@ -795,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: @@ -807,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' @@ -845,19 +566,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»» @@ -878,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 @@ -902,6 +610,9 @@ definitions: ricName: type: string description: identity of the ric + state: + type: string + description: state info title: RicInfo ServiceRegistrationInfo: type: object