Minor documentation updates.

[nonrtric.git] / information-coordinator-service / api / ics-api.yaml

diff --git a/information-coordinator-service/api/ics-api.yaml b/information-coordinator-service/api/ics-api.yaml
index be8fc94..0f73cd0 100644 (file)
--- 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: <h1>API documentation</h1><h2>General</h2><p>  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. <br /><br />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><h2>APIs provided by the
-    service</h2><h4>A1-EI</h4><p>  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><h4>Data producer API</h4><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:<ul><li>Registry of supported
-    information types and which parameters needed to setup a subscription.</li><li>Registry
-    of existing data producers.</li><li>Callback API provided by producers to setup
-    subscriptions.</li></ul></p><h4>Data consumer API</h4><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 consumers and provides support for:<ul><li>Querying
-    of available types of data to consume.</li><li>Management of data subscription
-    jobs</li><li>Optional callback API provided by consumers to get notification on
-    added and removed information types.</li></ul></p><h4>Service status</h4><p>  This
-    API provides a means to monitor the health of this service.</p>
+  description: '<h1>API documentation</h1><h2>General</h2><p>  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.  <br /><br />  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:  <ul>   <li>Parameters related to
+    delivery (Kafka stream, callback URL etc.). These are different for different
+    delivery protocols.</li>   <li>Filtering information (scope, filter or other discriminators).</li>   <li>Periodicy</li>   <li>Other
+    info used for aggregation</li>   <ul></p><h2>APIs provided by the service</h2><h4>A1-EI</h4><p>  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><h4>Data producer API</h4><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:<ul><li>Registry of supported information types and which parameters
+    needed to setup a subscription.</li><li>Registry of existing data producers.</li><li>Callback
+    API provided by producers to setup subscriptions.</li></ul></p><h4>Data consumer
+    API</h4><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
+    consumers and provides support for:<ul><li>Querying of available types of data
+    to consume.</li><li>Management of data subscription jobs</li><li>Optional callback
+    API provided by consumers to get notification on added and removed information
+    types.</li></ul></p><h4>Service status</h4><p>  This API provides a means to monitor
+    the health of this service.</p>'
   license:
     name: Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.
     url: http://www.apache.org/licenses/LICENSE-2.0