Added Information consumer API

[nonrtric.git] / enrichment-coordinator-service / src / main / java / org / oransc / enrichment / SwaggerConfig.java

diff --git a/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java b/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java
index fdfc0c9..58f69de 100644 (file)
--- a/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java
+++ b/enrichment-coordinator-service/src/main/java/org/oransc/enrichment/SwaggerConfig.java
@@ -26,8 +26,9 @@ import io.swagger.v3.oas.annotations.info.License;
 import io.swagger.v3.oas.annotations.tags.Tag;
 
 import org.oransc.enrichment.controllers.StatusController;
-import org.oransc.enrichment.controllers.consumer.ConsumerConsts;
-import org.oransc.enrichment.controllers.producer.ProducerConsts;
+import org.oransc.enrichment.controllers.a1e.A1eConsts;
+import org.oransc.enrichment.controllers.r1consumer.ConsumerConsts;
+import org.oransc.enrichment.controllers.r1producer.ProducerConsts;
 
 /**
  * Swagger configuration class that uses swagger documentation type and scans
@@ -36,17 +37,18 @@ import org.oransc.enrichment.controllers.producer.ProducerConsts;
  */
 
 @OpenAPIDefinition( //
-    tags = {@Tag(name = ConsumerConsts.CONSUMER_API_NAME, description = ConsumerConsts.CONSUMER_API_DESCRIPTION),
-        @Tag(
-            name = ConsumerConsts.CONSUMER_API_CALLBACKS_NAME,
-            description = ConsumerConsts.CONSUMER_API_CALLBACKS_DESCRIPTION),
+    tags = { //
+        @Tag(name = A1eConsts.CONSUMER_API_NAME, description = A1eConsts.CONSUMER_API_DESCRIPTION),
+        @Tag(name = A1eConsts.CONSUMER_API_CALLBACKS_NAME, description = A1eConsts.CONSUMER_API_CALLBACKS_DESCRIPTION),
         @Tag(
             name = ProducerConsts.PRODUCER_API_CALLBACKS_NAME,
             description = ProducerConsts.PRODUCER_API_CALLBACKS_DESCRIPTION),
         @Tag(name = ProducerConsts.PRODUCER_API_NAME, description = ProducerConsts.PRODUCER_API_DESCRIPTION), //
-        @Tag(name = StatusController.API_NAME, description = StatusController.API_DESCRIPTION)}, //
+        @Tag(name = StatusController.API_NAME, description = StatusController.API_DESCRIPTION), //
+        @Tag(name = ConsumerConsts.CONSUMER_API_NAME, description = ConsumerConsts.CONSUMER_API_DESCRIPTION), //
+    }, //
     info = @Info(
-        title = "Enrichment Information Service", //
+        title = SwaggerConfig.API_TITLE, //
         version = "1.0", //
         description = SwaggerConfig.DESCRIPTION, //
         license = @License(
@@ -56,20 +58,37 @@ public class SwaggerConfig {
     private SwaggerConfig() {
     }
 
-    static final String API_TITLE = "Enrichment Data service";
+    static final String API_TITLE = "Data management and exposure";
 
     static final String 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 producer one or several type of data (EI type). One type of data can be produced by zero to many producers. <br /><br />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." //
+        + "  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. <br /><br />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." //
         + "</p>" //
         + "<h2>APIs provided by the service</h2>" //
         + "<h4>A1-EI</h4>" //
         + "<p>" //
-        + "  This API is between Near-RT RIC, which is a data consumer, and the Non-RT RIC. " //
-        + "</p>" + "<h4>Data producer API</h4>" //
-        + "<p>"
-        + "  This API is between data producers and this service. It is divivided into two parts, where one is provided by this service (registration) and one part is provided by the data producer."
+        + "  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." //
+        + "</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>" //
+        + "</ul>" //
         + "</p>" //
         + "<h4>EI Service status</h4>" //
         + "<p>" //