X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;f=enrichment-coordinator-service%2Fapi%2Fecs-api.yaml;h=c4463b0285cbca72d45b626dcda3c18985bff4da;hb=refs%2Fchanges%2F36%2F6936%2F1;hp=f94743e28a4756cf21b7bfdfbc8dfc1dc0416996;hpb=6c468636c3790e3420da97dab19057892988fa11;p=nonrtric.git diff --git a/enrichment-coordinator-service/api/ecs-api.yaml b/enrichment-coordinator-service/api/ecs-api.yaml index f94743e2..c4463b02 100644 --- a/enrichment-coordinator-service/api/ecs-api.yaml +++ b/enrichment-coordinator-service/api/ecs-api.yaml @@ -3,23 +3,26 @@ info: title: Data management and exposure description:
The service is mainly
a broker between data producers and data consumers. A data producer has the ability
- to produce one or several types of data (EI type). One type of data can be produced
- by zero to many producers.
A data consumer can have several active
- data subscriptions (EI job). One EI job consists of the type of data to produce
- and additional parameters for filtering of the data. These parameters are different
- for different data types.
This - API is between Near-RT RIC and the Non-RT RIC. The Near-RT RIC is a data consumer, - which creates Enrichment Information Jobs to subscribe for data.
This API is provided by the Non-RT RIC platform and is intended to - be part of the O-RAN R1 interface. The API is for use by different kinds of data - producers and provides support for:
This API is provided by the Non-RT RIC platform and is intended - to be part of the O-RAN R1 interface. The API is for use by different kinds of - data consumers and provides support for:
This API provides a means to monitor the service.
+ to produce one or several types of data (Information Type). One type of data can + be produced by zero to many producers.This API is between Near-RT RIC and the Non-RT + RIC. The Near-RT RIC is a data consumer, which creates Information Jobs to subscribe + for data. In this context, the information is referred to as 'Enrichment Information', + EI.
This API is provided by the Non-RT RIC platform + and is intended to be part of the O-RAN R1 interface. The API is for use by different + kinds of data producers and provides support for:
This API is provided + by the Non-RT RIC platform and is intended to be part of the O-RAN R1 interface. The + API is for use by different kinds of data consumers and provides support for:
This + API provides a means to monitor the health of this service.
license: name: Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License. url: http://www.apache.org/licenses/LICENSE-2.0 @@ -40,20 +43,22 @@ tags: - name: Data consumer description: API for data consumers paths: - /producer_simulator/ei_job: - post: + /example_dataproducer/info_job/{infoJobId}: + delete: tags: - Data producer (callbacks) - summary: Callback for EI job creation/modification - description: The call is invoked to activate or to modify a data subscription. - The endpoint is provided by the EI producer. - operationId: jobCreatedCallback - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/producer_ei_job_request' + 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 @@ -61,12 +66,27 @@ paths: application/json: schema: $ref: '#/components/schemas/Void' + /data-producer/v1/info-types: + get: + tags: + - Data producer (registration) + summary: Info Type identifiers + operationId: getInfoTypdentifiers + responses: + 200: + description: Info Type identifiers + content: + application/json: + schema: + type: array + items: + type: string /A1-EI/v1/eitypes/{eiTypeId}: get: tags: - A1-EI (registration) summary: Individual EI type - operationId: getEiType_1 + operationId: getEiType parameters: - name: eiTypeId in: path @@ -88,88 +108,99 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /ei-producer/v1/eitypes: - get: + /example_dataproducer/info_job: + post: tags: - - Data producer (registration) - summary: EI type identifiers - operationId: getEiTypeIdentifiers + - 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: EI type identifiers + description: OK content: application/json: schema: - type: array - items: - type: string - /A1-EI/v1/eitypes: + $ref: '#/components/schemas/Void' + /data-producer/v1/info-types/{infoTypeId}: get: tags: - - A1-EI (registration) - summary: EI type identifiers - operationId: getEiTypeIdentifiers_1 + - Data producer (registration) + summary: Individual Information Type + operationId: getInfoType + parameters: + - name: infoTypeId + in: path + required: true + style: simple + explode: false + schema: + type: string responses: 200: - description: EI type identifiers + description: Info Type content: application/json: schema: - type: array - items: - type: string - /data-consumer/v1/info-types: - get: - tags: - - Data consumer - summary: Information type identifiers - operationId: getinfoTypeIdentifiers - responses: - 200: - description: Information type identifiers + $ref: '#/components/schemas/producer_info_type_info' + 404: + description: Information type is not found content: application/json: schema: - type: array - items: - type: string - /ei-producer/v1/eiproducers/{eiProducerId}/status: - get: + $ref: '#/components/schemas/ProblemDetails' + put: tags: - Data producer (registration) - summary: EI producer status - operationId: getEiProducerStatus + summary: Individual Information Type + operationId: putInfoType parameters: - - name: eiProducerId + - name: infoTypeId in: path required: true style: simple explode: false schema: type: string + requestBody: + content: + application/json: + schema: + $ref: '#/components/schemas/producer_info_type_info' + required: true responses: 200: - description: EI producer status + description: Type updated content: application/json: schema: - $ref: '#/components/schemas/producer_status' - 404: - description: Enrichment Information producer is not found + $ref: '#/components/schemas/Void' + 201: + description: Type created + content: + application/json: + schema: + $ref: '#/components/schemas/Void' + 400: + description: Input validation failed content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /producer_simulator/ei_job/{eiJobId}: delete: tags: - - Data producer (callbacks) - summary: Callback for EI job deletion - description: The call is invoked to terminate a data subscription. The endpoint - is provided by the EI producer. - operationId: jobDeletedCallback + - Data producer (registration) + summary: Individual Information Type + operationId: deleteInfoType parameters: - - name: eiJobId + - name: infoTypeId in: path required: true style: simple @@ -178,19 +209,37 @@ paths: type: string responses: 200: - description: OK + description: Not used + content: + application/json: + schema: + $ref: '#/components/schemas/Void' + 204: + description: Producer deleted content: application/json: schema: $ref: '#/components/schemas/Void' - /ei-producer/v1/eitypes/{eiTypeId}: + 404: + description: Information type is not found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: The Information type has one or several active producers + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /data-consumer/v1/info-type-subscription/{subscriptionId}: get: tags: - - Data producer (registration) - summary: Individual EI type - operationId: getEiType + - Data consumer + summary: Individual subscription for information types (registration/deregistration) + operationId: getIndividualTypeSubscription parameters: - - name: eiTypeId + - name: subscriptionId in: path required: true style: simple @@ -199,24 +248,26 @@ paths: type: string responses: 200: - description: EI type + description: Type subscription content: application/json: schema: - $ref: '#/components/schemas/producer_ei_type_info' + $ref: '#/components/schemas/consumer_type_subscription_info' 404: - description: Enrichment Information type is not found + description: Subscription is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - - Data producer (registration) - summary: Individual EI type - operationId: putEiType + - Data consumer + summary: Individual subscription for information types (registration/deregistration) + description: This service operation is used to subscribe to notifications for + changes in the availability of data types. + operationId: putIndividualTypeSubscription parameters: - - name: eiTypeId + - name: subscriptionId in: path required: true style: simple @@ -227,34 +278,28 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/producer_ei_type_info' + $ref: '#/components/schemas/consumer_type_subscription_info' required: true responses: 200: - description: Type updated + description: Subscription updated content: application/json: schema: $ref: '#/components/schemas/Void' 201: - description: Type created + description: Subscription created content: application/json: schema: $ref: '#/components/schemas/Void' - 400: - description: Bad request - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' delete: tags: - - Data producer (registration) - summary: Individual EI type - operationId: deleteEiType + - Data consumer + summary: Individual subscription for information types (registration/deregistration) + operationId: deleteIndividualTypeSubscription parameters: - - name: eiTypeId + - name: subscriptionId in: path required: true style: simple @@ -269,68 +314,70 @@ paths: schema: $ref: '#/components/schemas/Void' 204: - description: Producer deleted + description: Subscription deleted content: application/json: schema: $ref: '#/components/schemas/Void' 404: - description: Enrichment Information type is not found + description: Subscription is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - 406: - description: The Enrichment Information type has one or several active producers + /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: - $ref: '#/components/schemas/ProblemDetails' - /status: + type: string + /A1-EI/v1/eitypes: get: tags: - - Service status - summary: Returns status and statistics of this service - operationId: getStatus + - A1-EI (registration) + summary: EI type identifiers + operationId: getEiTypeIdentifiers responses: 200: - description: Service is living + description: EI type identifiers content: application/json: schema: - $ref: '#/components/schemas/status_info' - /ei-producer/v1/eiproducers: + type: array + items: + type: string + /data-consumer/v1/info-types: get: tags: - - Data producer (registration) - summary: EI producer identifiers - operationId: getEiProducerIdentifiers - parameters: - - name: ei_type_id - in: query - description: If given, only the producers for the EI Data type is returned. - required: false - style: form - explode: true - schema: - type: string + - Data consumer + summary: Information type identifiers + operationId: getinfoTypeIdentifiers responses: 200: - description: EI producer identifiers + description: Information type identifiers content: application/json: schema: type: array items: type: string - /A1-EI/v1/eijobs/{eiJobId}: + /data-producer/v1/info-producers/{infoProducerId}: get: tags: - - A1-EI (registration) - summary: Individual EI job - operationId: getIndividualEiJob_1 + - Data producer (registration) + summary: Individual Information Producer + operationId: getInfoProducer parameters: - - name: eiJobId + - name: infoProducerId in: path required: true style: simple @@ -339,24 +386,24 @@ paths: type: string responses: 200: - description: EI job + description: Information producer content: application/json: schema: - $ref: '#/components/schemas/EiJobObject' + $ref: '#/components/schemas/producer_registration_info' 404: - description: Enrichment Information job is not found + description: Information producer is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - - A1-EI (registration) - summary: Individual EI job - operationId: putIndividualEiJob + - Data producer (registration) + summary: Individual Information Producer + operationId: putInfoProducer parameters: - - name: eiJobId + - name: infoProducerId in: path required: true style: simple @@ -367,34 +414,40 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/EiJobObject' + $ref: '#/components/schemas/producer_registration_info' required: true responses: 200: - description: Job updated + description: Producer updated content: application/json: schema: $ref: '#/components/schemas/Void' 201: - description: Job created + description: Producer created content: application/json: schema: $ref: '#/components/schemas/Void' + 400: + description: Input validation failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' 404: - description: Enrichment Information type is not found + description: Producer type not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' delete: tags: - - A1-EI (registration) - summary: Individual EI job - operationId: deleteIndividualEiJob_1 + - Data producer (registration) + summary: Individual Information Producer + operationId: deleteInfoProducer parameters: - - name: eiJobId + - name: infoProducerId in: path required: true style: simple @@ -409,25 +462,63 @@ paths: schema: $ref: '#/components/schemas/Void' 204: - description: Job deleted + description: Producer deleted content: application/json: schema: $ref: '#/components/schemas/Void' 404: - description: Enrichment Information job is not found + description: Producer is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /ei-producer/v1/eiproducers/{eiProducerId}: + /status: get: tags: - - Data producer (registration) - summary: Individual EI producer - operationId: getEiProducer + - Service status + summary: Returns status and statistics of this service + operationId: getStatus + responses: + 200: + description: Service is living + content: + application/json: + schema: + $ref: '#/components/schemas/service_status_info' + /data-consumer/v1/info-type-subscription: + get: + tags: + - Data consumer + summary: Information type subscription identifiers + description: query for information type subscription identifiers + operationId: getInfoTypeSubscriptions + parameters: + - name: owner + in: query + description: selects result for one owner + required: false + style: form + explode: true + schema: + type: string + responses: + 200: + description: Information type subscription identifiers + content: + application/json: + schema: + type: array + items: + type: string + /A1-EI/v1/eijobs/{eiJobId}: + get: + tags: + - A1-EI (registration) + summary: Individual EI job + operationId: getIndividualEiJob_1 parameters: - - name: eiProducerId + - name: eiJobId in: path required: true style: simple @@ -436,24 +527,24 @@ paths: type: string responses: 200: - description: EI producer + description: EI job content: application/json: schema: - $ref: '#/components/schemas/producer_registration_info' + $ref: '#/components/schemas/EiJobObject' 404: - description: Enrichment Information producer is not found + description: Enrichment Information job is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' put: tags: - - Data producer (registration) - summary: Individual EI producer - operationId: putEiProducer + - A1-EI (registration) + summary: Individual EI job + operationId: putIndividualEiJob parameters: - - name: eiProducerId + - name: eiJobId in: path required: true style: simple @@ -464,34 +555,46 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/producer_registration_info' + $ref: '#/components/schemas/EiJobObject' required: true responses: 200: - description: Producer updated + description: Job updated + content: + application/json: + schema: + $ref: '#/components/schemas/Void' + 201: + description: Job created content: application/json: schema: $ref: '#/components/schemas/Void' - 201: - description: Producer created + 400: + description: Input validation failed content: application/json: schema: - $ref: '#/components/schemas/Void' + $ref: '#/components/schemas/ProblemDetails' 404: - description: Producer not found + description: Enrichment Information type is not found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: Cannot modify job type content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' delete: tags: - - Data producer (registration) - summary: Individual EI producer - operationId: deleteEiProducer + - A1-EI (registration) + summary: Individual EI job + operationId: deleteIndividualEiJob_1 parameters: - - name: eiProducerId + - name: eiJobId in: path required: true style: simple @@ -506,37 +609,22 @@ paths: schema: $ref: '#/components/schemas/Void' 204: - description: Producer deleted + description: Job deleted content: application/json: schema: $ref: '#/components/schemas/Void' 404: - description: Producer is not found + description: Enrichment Information job is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /producer_simulator/health_check: - get: - tags: - - Data producer (callbacks) - summary: Producer supervision - description: The endpoint is provided by the EI producer and is used for supervision - of the producer. - operationId: producerSupervision - responses: - 200: - description: The producer is OK - content: - application/json: - schema: - type: string /data-consumer/v1/info-jobs: get: tags: - Data consumer - summary: EI job identifiers + summary: Information Job identifiers description: query for information job identifiers operationId: getJobIds parameters: @@ -550,7 +638,7 @@ paths: type: string - name: owner in: query - description: selects subscription jobs for one job owner + description: selects result for one owner required: false style: form explode: true @@ -591,7 +679,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/Job' + $ref: '#/components/schemas/consumer_job' 404: description: Information subscription job is not found content: @@ -602,6 +690,7 @@ paths: tags: - Data consumer summary: Individual data subscription job + description: The job will be enabled when a producer is available operationId: putIndividualInfoJob parameters: - name: infoJobId @@ -611,11 +700,21 @@ paths: explode: false schema: type: string + - name: typeCheck + in: query + description: when true, a validation of that the type exists and that the + job matches the type schema. + required: false + style: form + explode: true + schema: + type: boolean + default: false requestBody: content: application/json: schema: - $ref: '#/components/schemas/Job' + $ref: '#/components/schemas/consumer_job' required: true responses: 200: @@ -630,8 +729,20 @@ paths: application/json: schema: $ref: '#/components/schemas/Void' + 400: + description: Input validation failed + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' 404: - description: Enrichment Information type is not found + description: Information type is not found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + 409: + description: Cannot modify job type content: application/json: schema: @@ -668,42 +779,36 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /ei-producer/v1/eiproducers/{eiProducerId}/eijobs: + /data-producer/v1/info-producers: get: tags: - Data producer (registration) - summary: EI job definitions - description: EI job definitions for one EI producer - operationId: getEiProducerJobs + summary: Information producer identifiers + operationId: getInfoProducerIdentifiers parameters: - - name: eiProducerId - in: path - required: true - style: simple - explode: false + - name: info_type_id + in: query + description: If given, only the producers for the EI Data type is returned. + required: false + style: form + explode: true schema: type: string responses: 200: - description: EI producer + description: Information producer identifiers content: application/json: schema: type: array items: - $ref: '#/components/schemas/producer_ei_job_request' - 404: - description: Enrichment Information producer is not found - content: - application/json: - schema: - $ref: '#/components/schemas/ProblemDetails' + type: string /data-consumer/v1/info-types/{infoTypeId}: get: tags: - Data consumer summary: Individual information type - operationId: getInfoType + operationId: getInfoType_1 parameters: - name: infoTypeId in: path @@ -718,13 +823,42 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/InformationType' + $ref: '#/components/schemas/consumer_information_type' 404: description: Information type is not found content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' + /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' /A1-EI/v1/eijobs: get: tags: @@ -791,35 +925,63 @@ paths: application/json: schema: $ref: '#/components/schemas/ProblemDetails' - /example_dataconsumer/eijobs/{eiJobId}/status: - post: + /data-producer/v1/info-producers/{infoProducerId}/status: + get: tags: - - A1-EI (callbacks) - summary: Callback for changed EI job status - description: The primitive is implemented by the data consumer and is invoked - when a EI job status has been changed. - operationId: jobStatusCallback + - Data producer (registration) + summary: Information producer status + operationId: getInfoProducerStatus parameters: - - name: eiJobId + - name: infoProducerId in: path required: true style: simple explode: false schema: type: string - requestBody: - content: - application/json: - schema: - $ref: '#/components/schemas/EiJobStatusObject' + responses: + 200: + description: Information producer status + content: + application/json: + schema: + $ref: '#/components/schemas/producer_status' + 404: + description: Information producer is not found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' + /data-producer/v1/info-producers/{infoProducerId}/info-jobs: + get: + tags: + - Data producer (registration) + summary: Information Job definitions + description: Information Job definitions for one Information Producer + operationId: getInfoProducerJobs + parameters: + - name: infoProducerId + in: path required: true + style: simple + explode: false + schema: + type: string responses: 200: - description: OK + description: Information producer content: application/json: schema: - $ref: '#/components/schemas/Void' + type: array + items: + $ref: '#/components/schemas/producer_info_job_request' + 404: + description: Information producer is not found + content: + application/json: + schema: + $ref: '#/components/schemas/ProblemDetails' /data-consumer/v1/info-jobs/{infoJobId}/status: get: tags: @@ -840,43 +1002,64 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/JobStatus' + $ref: '#/components/schemas/consumer_job_status' 404: description: Information subscription job is not found content: 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.