X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=information-coordinator-service%2Fapi%2Fics-api.yaml;fp=information-coordinator-service%2Fapi%2Fics-api.yaml;h=2d12193457d40bc83ccfa06a0cb4387ea9bd45d2;hb=721a0c1f9728a06c78edd75ba898bc67c4b82446;hp=dafb0ffd027d3e7b2d6a0471ebc05f689d8c3b1c;hpb=e2871f2bfeb581ba608640cb8daae89430632914;p=nonrtric.git diff --git a/information-coordinator-service/api/ics-api.yaml b/information-coordinator-service/api/ics-api.yaml index dafb0ffd..2d121934 100644 --- a/information-coordinator-service/api/ics-api.yaml +++ b/information-coordinator-service/api/ics-api.yaml @@ -24,27 +24,22 @@ info: added and removed information types.

Service status

This API provides a means to monitor the health of this service.

license: - name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License. + name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License. url: http://www.apache.org/licenses/LICENSE-2.0 version: "1.0" servers: - url: / tags: -- name: A1-EI (callbacks) -- name: Data producer (callbacks) - description: API implemented by data producers -- name: Data consumer -- name: Data consumer (callbacks) - name: A1-EI (registration) description: Data consumer EI job registration - name: A1-EI (callbacks) description: Data consumer EI job status callbacks -- name: Service status -- name: A1-EI (registration) -- name: Data producer (registration) -- name: Data producer (callbacks) +- name: Data consumer (callbacks) + description: API for data consumers - name: Data producer (registration) description: API for data producers +- name: Data producer (callbacks) + description: API implemented by data producers - name: Data consumer description: API for data consumers - name: Service status @@ -55,29 +50,6 @@ tags: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/ paths: - /example_dataproducer/info_job/{infoJobId}: - delete: - tags: - - Data producer (callbacks) - summary: Callback for Information Job deletion - description: The call is invoked to terminate a data subscription. The endpoint - is provided by the Information Producer. - operationId: jobDeletedCallback - parameters: - - name: infoJobId - in: path - required: true - style: simple - explode: false - schema: - type: string - responses: - 200: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Void' /data-producer/v1/info-types: get: tags: @@ -133,27 +105,6 @@ paths: '*/*': schema: type: object - /example_dataproducer/info_job: - post: - tags: - - Data producer (callbacks) - summary: Callback for Information Job creation/modification - description: The call is invoked to activate or to modify a data subscription. - The endpoint is provided by the Information Producer. - operationId: jobCreatedCallback - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/producer_info_job_request' - required: true - responses: - 200: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Void' /data-producer/v1/info-types/{infoTypeId}: get: tags: @@ -350,6 +301,21 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' + /example-dataproducer/health-check: + get: + tags: + - Data producer (callbacks) + summary: Producer supervision + description: The endpoint is provided by the Information Producer and is used + for supervision of the producer. + operationId: producerSupervision + responses: + 200: + description: The producer is OK + content: + application/json: + schema: + type: string /actuator/loggers: get: tags: @@ -391,6 +357,28 @@ paths: type: array items: type: string + /example-dataconsumer/info-type-status: + post: + tags: + - Data consumer (callbacks) + summary: Callback for changed Information type registration status + description: The primitive is implemented by the data consumer and is invoked + when a Information type status has been changed.
Subscription are managed + by primitives in 'Data consumer' + operationId: typeStatusCallback + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/consumer_type_registration_info' + required: true + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Void' /actuator/metrics/{requiredMetricName}: get: tags: @@ -509,14 +497,35 @@ paths: '*/*': schema: type: object - /example_dataconsumer/info_jobs/{infoJobId}/status: + /example-dataproducer/info-job: post: tags: - - A1-EI (callbacks) - summary: Callback for changed Information Job status - description: The primitive is implemented by the data consumer and is invoked - when a Information Job status has been changed. - operationId: jobStatusCallback + - Data producer (callbacks) + summary: Callback for Information Job creation/modification + description: The call is invoked to activate or to modify a data subscription. + The endpoint is provided by the Information Producer. + operationId: jobCreatedCallback + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/producer_info_job_request' + required: true + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Void' + /example-dataproducer/info-job/{infoJobId}: + delete: + tags: + - Data producer (callbacks) + summary: Callback for Information Job deletion + description: The call is invoked to terminate a data subscription. The endpoint + is provided by the Information Producer. + operationId: jobDeletedCallback parameters: - name: infoJobId in: path @@ -525,12 +534,6 @@ paths: explode: false schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EiJobStatusObject' - required: true responses: 200: description: OK @@ -632,6 +635,35 @@ paths: '*/*': schema: type: object + /example-dataconsumer/info-jobs/{infoJobId}/status: + post: + tags: + - A1-EI (callbacks) + summary: Callback for changed Information Job status + description: The primitive is implemented by the data consumer and is invoked + when a Information Job status has been changed. + operationId: jobStatusCallback + parameters: + - name: infoJobId + in: path + required: true + style: simple + explode: false + schema: + type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/EiJobStatusObject' + required: true + responses: + 200: + description: OK + content: + application/json: + schema: + $ref: '#/components/schemas/Void' /actuator/info: get: tags: @@ -645,21 +677,6 @@ paths: '*/*': schema: type: object - /example_dataproducer/health_check: - get: - tags: - - Data producer (callbacks) - summary: Producer supervision - description: The endpoint is provided by the Information Producer and is used - for supervision of the producer. - operationId: producerSupervision - responses: - 200: - description: The producer is OK - content: - application/json: - schema: - type: string /A1-EI/v1/eitypes: get: tags: @@ -1065,7 +1082,7 @@ paths: summary: Information producer identifiers operationId: getInfoProducerIdentifiers parameters: - - name: info_type_id + - name: infoTypeId in: query description: If given, only the producers for the EI Data type is returned. required: false @@ -1191,28 +1208,6 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /example_dataconsumer/info_type_status: - post: - tags: - - Data consumer (callbacks) - summary: Callback for changed Information type registration status - description: The primitive is implemented by the data consumer and is invoked - when a Information type status has been changed.
Subscription are managed - by primitives in 'Data consumer' - operationId: typeStatusCallback - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/consumer_type_registration_info' - required: true - responses: - 200: - description: OK - content: - application/json: - schema: - $ref: '#/components/schemas/Void' /actuator/heapdump: get: tags: