From 028b1864ad03abb6692a0f16190f8eb4688b1d43 Mon Sep 17 00:00:00 2001
From: PatrikBuhr 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 (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.<\/p> 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.<\/p>",
+ "description": " The ICS is a data subscription service which decouples data producers from data consumers. A data consumer can create a data subscription (Information Job) without any knowledge of its data producers (one subscription may involve several data producers). A data producer has the ability 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.<\/p> 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.<\/p>",
"title": "Data management and exposure",
"version": "1.0"
},
diff --git a/information-coordinator-service/api/ics-api.yaml b/information-coordinator-service/api/ics-api.yaml
index be8fc949..0f73cd06 100644
--- a/information-coordinator-service/api/ics-api.yaml
+++ b/information-coordinator-service/api/ics-api.yaml
@@ -1,28 +1,34 @@
openapi: 3.0.1
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 (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:API documentation<\/h1>
General<\/h2>
A data consumer can have several active data subscriptions (Information Job). One Information 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.<\/p>APIs provided by the service<\/h2>
A1-EI<\/h4>
Data producer API<\/h4>
Data consumer API<\/h4>
Service status<\/h4>
API documentation<\/h1>
General<\/h2>
A data consumer can have several active data subscriptions (Information Job). One Information Job consists of the type of data to produce and additional parameters, which may be different for different data types. These parameters are not defined or limited by this service and may for instance include:
<\/p>
APIs provided by the service<\/h2>
A1-EI<\/h4>
Data producer API<\/h4>
Data consumer API<\/h4>
Service status<\/h4>
API documentation
General
A data consumer can have several
- active data subscriptions (Information Job). One Information 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.APIs provided by the
- service
A1-EI
Data producer API
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.
+ description: ' The ICS is a data subscription
+ service which decouples data producers from data consumers. A data consumer can
+ create a data subscription (Information Job) without any knowledge of its data
+ producers (one subscription may involve several data producers). A data producer
+ has the ability to produce one or several types of data (Information Type). One
+ type of data can be produced by zero to many producers.
A data
+ consumer can have several active data subscriptions (Information Job). One Information
+ Job consists of the type of data to produce and additional parameters, which may
+ be different for different data types. These parameters are not defined or limited
+ by this service and may for instance include:
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-2022 Nordix Foundation. Licensed under the Apache License. url: http://www.apache.org/licenses/LICENSE-2.0 diff --git a/information-coordinator-service/src/main/java/org/oransc/ics/SwaggerConfig.java b/information-coordinator-service/src/main/java/org/oransc/ics/SwaggerConfig.java index 30c0d4a0..98c6e81b 100644 --- a/information-coordinator-service/src/main/java/org/oransc/ics/SwaggerConfig.java +++ b/information-coordinator-service/src/main/java/org/oransc/ics/SwaggerConfig.java @@ -47,7 +47,16 @@ public class SwaggerConfig { static final String 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 (Information Type). One type of data can be produced by zero to many producers.
A data consumer can have several active data subscriptions (Information Job). One Information 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." //
+ + " The ICS is a data subscription service which decouples data producers from data consumers."
+ + " A data consumer can create a data subscription (Information Job) without any knowledge of its data producers (one subscription may involve several data producers)."
+ + " A data producer has the ability to produce one or several types of data (Information Type)."
+ + " One type of data can be produced by zero to many producers." + "
"
+ + " A data consumer can have several active data subscriptions (Information Job)."
+ + " One Information Job consists of the type of data to produce and additional parameters, which may be different for different data types." //
+ + " These parameters are not defined or limited by this service and may for instance include:" + "