diff options
Diffstat (limited to 'a1-policy-management/open-api-fragments/v3-fragments/service-api.yaml')
| -rw-r--r-- | a1-policy-management/open-api-fragments/v3-fragments/service-api.yaml | 178 |
1 files changed, 178 insertions, 0 deletions
diff --git a/a1-policy-management/open-api-fragments/v3-fragments/service-api.yaml b/a1-policy-management/open-api-fragments/v3-fragments/service-api.yaml new file mode 100644 index 00000000..bec1de4d --- /dev/null +++ b/a1-policy-management/open-api-fragments/v3-fragments/service-api.yaml @@ -0,0 +1,178 @@ +keep-alive: + put: + operationId: keepAliveService + description: A registered service should invoke this operation regularly to + indicate that it is still alive. If a registered service fails to invoke some operation, + or this operation, before the end of a timeout period the service will be deregistered + and all its A1 policies wil be removed and the service is deleted. + This operation is only intended for registered services. (This timeout can be set or disabled when + each service is initially registered). Unregistered services do not need to invoke this operation, + since the optional keep-alive monitoring feature can only be enabled for registered services. + summary: Heartbeat message from a service (keepAliveService) + tags: + - Service Registry and Supervision + parameters: + - explode: false + in: path + name: serviceId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + requestBody: + required: false + content: + application/json: + schema: + type: string + responses: + "200": + content: + 'application/json': + schema: + type: object + description: OK - Service supervision timer refreshed, OK + "404": + $ref: 'responses.yaml#/responses/404' + +services: + get: + operationId: getServices + description: > + Get information about all registered services, or a single registered service. + If the service ID of a registered service is included in the query, information about that + service is returned. Otherwise Information about all registered is returned. + This operation does not retrieve information about unregistered services. + summary: Get Services (getServices) + tags: + - Service Registry and Supervision + parameters: + - description: The identity of the registered service + explode: true + in: query + name: serviceId + required: false + schema: + type: string + style: form + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "200": + content: + application/json: + schema: + $ref: 'schemas.yaml#/schemas/ServiceStatusList' + examples: + service_status_list: + $ref: 'examples.yaml#/examples/ServiceStatusList' + description: OK + "404": + $ref: 'responses.yaml#/responses/404' + put: + operationId: putService + description: > + Register a single service, or update a previous registration. + Service registration is required to get callbacks about available NearRT RICs + and to enable supervision of the service's active status. If a registered + service becomes inactive, its policies can be automatically deleted. + A1 Policy instances can also be created for unregistered services. + If an unregistered service is later registered, the service's policies are + retained when the service becomes registered. This feature is optional to use. + summary: Register or update a Service (putService) + tags: + - Service Registry and Supervision + requestBody: + content: + application/json: + schema: + $ref: 'schemas.yaml#/schemas/ServiceRegistrationInfo' + required: true + responses: + "200": + content: + 'application/json': + schema: + type: object + description: OK - Service updated + "201": + content: + 'application/json': + schema: + type: object + description: Created - Service created + "400": + $ref: 'responses.yaml#/responses/400' + callbacks: + RICStatus: + "{$request.body#/callback_url}": + post: + operationId: serviceCallback + description: | + Callouts to indicate Near-RT RIC status changes relevant for Services. + The URL invoked by this callback is provided at Service registration. + summary: Callback for Near-RT RIC status (serviceCallback) + tags: + - Service Registry and Supervision + requestBody: + content: + application/json: + schema: + $ref: 'schemas.yaml#/schemas/ServiceCallbackInfo' + required: true + responses: + "200": + content: + application/json: + schema: + $ref: 'schemas.yaml#/schemas/void' + description: OK + "404": + $ref: 'responses.yaml#/responses/404' + +service: + delete: + operationId: deleteService + description: > + Unregister a registered Service using its service ID. + Only registered services can be unregistered. All A1 Policy Instances + for the previously registered service will be removed. + tags: + - Service Registry and Supervision + summary: Unregister a Service (deleteService) + parameters: + - explode: false + in: path + name: serviceId + required: true + schema: + type: string + style: simple + - description: Specifies the content type that the client expects to receive in response to the request. + Only application/json is allowed. + in: header + name: Accept + schema: + type: string + example: application/json + responses: + "204": + content: + 'application/json': + schema: + type: object + description: No Content - Service unregistered + "404": + $ref: 'responses.yaml#/responses/404'
\ No newline at end of file |