From 028b1864ad03abb6692a0f16190f8eb4688b1d43 Mon Sep 17 00:00:00 2001 From: PatrikBuhr Date: Mon, 4 Apr 2022 13:37:28 +0200 Subject: [PATCH] Minor documentation updates. Signed-off-by: PatrikBuhr Issue-ID: NONRTRIC-721 Change-Id: If05c0e2bc63a8f0144c82248a9c4ddaece451aef --- docs/overview.rst | 11 ++--- information-coordinator-service/api/ics-api.json | 2 +- information-coordinator-service/api/ics-api.yaml | 50 ++++++++++++---------- .../main/java/org/oransc/ics/SwaggerConfig.java | 11 ++++- 4 files changed, 43 insertions(+), 31 deletions(-) diff --git a/docs/overview.rst b/docs/overview.rst index 2d3ee66e..c96bded9 100644 --- a/docs/overview.rst +++ b/docs/overview.rst @@ -69,9 +69,9 @@ More details available at the `NONRTRIC-Portal documentation site `__. \ No newline at end of file +More details available at the `documentation site `__. diff --git a/information-coordinator-service/api/ics-api.json b/information-coordinator-service/api/ics-api.json index 56bbcb54..d49398c1 100644 --- a/information-coordinator-service/api/ics-api.json +++ b/information-coordinator-service/api/ics-api.json @@ -1244,7 +1244,7 @@ "name": "Copyright (C) 2020-2022 Nordix Foundation. Licensed under the Apache License.", "url": "http://www.apache.org/licenses/LICENSE-2.0" }, - "description": "

API documentation<\/h1>

General<\/h2>

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.<\/p>

APIs provided by the service<\/h2>

A1-EI<\/h4>

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>

Data producer API<\/h4>

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:

  • Registry of supported information types and which parameters needed to setup a subscription.<\/li>
  • Registry of existing data producers.<\/li>
  • Callback API provided by producers to setup subscriptions.<\/li><\/ul><\/p>

    Data consumer API<\/h4>

    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:

    • Querying of available types of data to consume.<\/li>
    • Management of data subscription jobs<\/li>
    • Optional callback API provided by consumers to get notification on added and removed information types.<\/li><\/ul><\/p>

      Service status<\/h4>

      This API provides a means to monitor the health of this service.<\/p>", + "description": "

      API documentation<\/h1>

      General<\/h2>

      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:

      • Parameters related to delivery (Kafka stream, callback URL etc.). These are different for different delivery protocols.<\/li>
      • Filtering information (scope, filter or other discriminators).<\/li>
      • Periodicy<\/li>
      • Other info used for aggregation<\/li>
          <\/p>

          APIs provided by the service<\/h2>

          A1-EI<\/h4>

          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>

          Data producer API<\/h4>

          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:

          • Registry of supported information types and which parameters needed to setup a subscription.<\/li>
          • Registry of existing data producers.<\/li>
          • Callback API provided by producers to setup subscriptions.<\/li><\/ul><\/p>

            Data consumer API<\/h4>

            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:

            • Querying of available types of data to consume.<\/li>
            • Management of data subscription jobs<\/li>
            • Optional callback API provided by consumers to get notification on added and removed information types.<\/li><\/ul><\/p>

              Service status<\/h4>

              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:

              API documentation

              General

              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.

              APIs provided by the - service

              A1-EI

              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.

              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 producers and provides support for:

              • Registry of supported - information types and which parameters needed to setup a subscription.
              • Registry - of existing data producers.
              • Callback API provided by producers to setup - subscriptions.

              Data consumer 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:

              • Querying - of available types of data to consume.
              • Management of data subscription - jobs
              • Optional callback API provided by consumers to get notification on - added and removed information types.

              Service status

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

              + description: '

              API documentation

              General

              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:

              • Parameters related to + delivery (Kafka stream, callback URL etc.). These are different for different + delivery protocols.
              • Filtering information (scope, filter or other discriminators).
              • Periodicy
              • Other + info used for aggregation

                  • APIs provided by the service

                  A1-EI

                  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.

                  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 producers and provides + support for:

                  • Registry of supported information types and which parameters + needed to setup a subscription.
                  • Registry of existing data producers.
                  • Callback + API provided by producers to setup subscriptions.

                  Data consumer + 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:

                  • Querying of available types of data + to consume.
                  • Management of data subscription jobs
                  • Optional callback + API provided by consumers to get notification on added and removed information + types.

                  Service status

                  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 = "

                  API documentation

                  " // + "

                  General

                  " // + "

                  " // - + " 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:" + "

                    " // + + "
                  • Parameters related to delivery (Kafka stream, callback URL etc.). These are different for different delivery protocols.
                    • " + + "
                  • Filtering information (scope, filter or other discriminators).
                    • " + "
                  • Periodicy
                    • " + + "
                  • Other info used for aggregation
                    • " + "
                      " // + "

                      " // + "

                      APIs provided by the service

                      " // + "

                      A1-EI

                      " // -- 2.16.6