X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=inline;f=information-coordinator-service%2Fapi%2Fics-api.yaml;h=be8fc9499b73475f0b0977035d27f128f5973cd1;hb=93a604b82da289316908c9bfff8380877aaf89e5;hp=03de106abfcf5a8d096fa2bcc86e0c4c584d95dd;hpb=bf0559240afb3cea1807c70eb51158e31e991786;p=nonrtric.git
diff --git a/information-coordinator-service/api/ics-api.yaml b/information-coordinator-service/api/ics-api.yaml
index 03de106a..be8fc949 100644
--- a/information-coordinator-service/api/ics-api.yaml
+++ b/information-coordinator-service/api/ics-api.yaml
@@ -24,7 +24,7 @@ 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:
@@ -34,43 +34,22 @@ tags:
description: Data consumer EI job registration
- name: A1-EI (callbacks)
description: Data consumer EI job status callbacks
-- name: Data producer (callbacks)
- description: API implemented by data producers
+- name: Data consumer (callbacks)
+ description: API for data consumers
- name: Data producer (registration)
description: API for data producers
-- name: Service status
- description: API for monitoring of the service
+- name: Data producer (callbacks)
+ description: API implemented by data producers
- name: Data consumer
description: API for data consumers
+- name: Service status
+ description: API for monitoring of the service
- name: Actuator
description: Monitor and interact
externalDocs:
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:
@@ -86,6 +65,19 @@ paths:
type: array
items:
type: string
+ /actuator/threaddump:
+ get:
+ tags:
+ - Actuator
+ summary: Actuator web endpoint 'threaddump'
+ operationId: threaddump_2
+ responses:
+ 200:
+ description: OK
+ content:
+ '*/*':
+ schema:
+ type: object
/A1-EI/v1/eitypes/{eiTypeId}:
get:
tags:
@@ -113,40 +105,6 @@ paths:
application/json:
schema:
$ref: '#/components/schemas/ProblemDetails'
- /actuator/threaddump:
- get:
- tags:
- - Actuator
- summary: Actuator web endpoint 'threaddump'
- operationId: handle_2_1_3
- responses:
- 200:
- description: OK
- content:
- '*/*':
- 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:
@@ -343,12 +301,27 @@ 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:
- Actuator
summary: Actuator web endpoint 'loggers'
- operationId: handle_6
+ operationId: loggers
responses:
200:
description: OK
@@ -361,7 +334,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'health-path'
- operationId: handle_12
+ operationId: health-path
responses:
200:
description: OK
@@ -384,12 +357,34 @@ 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:
- Actuator
summary: Actuator web endpoint 'metrics-requiredMetricName'
- operationId: handle_5
+ operationId: metrics-requiredMetricName
parameters:
- name: requiredMetricName
in: path
@@ -410,7 +405,7 @@ paths:
tags:
- Actuator
summary: Actuator root web endpoint
- operationId: links_1
+ operationId: links
responses:
200:
description: OK
@@ -466,7 +461,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: handle_7
+ operationId: loggers-name_2
parameters:
- name: name
in: path
@@ -486,7 +481,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'loggers-name'
- operationId: handle_0
+ operationId: loggers-name
parameters:
- name: name
in: path
@@ -502,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
@@ -518,12 +534,6 @@ paths:
explode: false
schema:
type: string
- requestBody:
- content:
- application/json:
- schema:
- $ref: '#/components/schemas/EiJobStatusObject'
- required: true
responses:
200:
description: OK
@@ -617,7 +627,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'metrics'
- operationId: handle_4
+ operationId: metrics
responses:
200:
description: OK
@@ -625,34 +635,48 @@ paths:
'*/*':
schema:
type: object
- /actuator/info:
- get:
+ /example-dataconsumer/info-jobs/{infoJobId}/status:
+ post:
tags:
- - Actuator
- summary: Actuator web endpoint 'info'
- operationId: handle_9
+ - 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:
- type: object
- /example_dataproducer/health_check:
+ $ref: '#/components/schemas/Void'
+ /actuator/info:
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
+ - Actuator
+ summary: Actuator web endpoint 'info'
+ operationId: info
responses:
200:
- description: The producer is OK
+ description: OK
content:
- application/json:
+ '*/*':
schema:
- type: string
+ type: object
/A1-EI/v1/eitypes:
get:
tags:
@@ -923,7 +947,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'logfile'
- operationId: handle_8
+ operationId: logfile
responses:
200:
description: OK
@@ -1058,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
@@ -1107,7 +1131,7 @@ paths:
tags:
- Actuator
summary: Actuator web endpoint 'health'
- operationId: handle_11
+ operationId: health
responses:
200:
description: OK
@@ -1184,34 +1208,12 @@ 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:
- Actuator
summary: Actuator web endpoint 'heapdump'
- operationId: handle_10
+ operationId: heapdump
responses:
200:
description: OK