X-Git-Url: https://gerrit.o-ran-sc.org/r/gitweb?a=blobdiff_plain;ds=sidebyside;f=enrichment-coordinator-service%2Fsrc%2Fmain%2Fjava%2Forg%2Foransc%2Fenrichment%2FSwaggerConfig.java;h=5f61e3128eba487595d14559fe9fe2734049f4ee;hb=194b712cc0d58def2e02c8532f6fa503856c1fda;hp=944cbf0bb258453bbf58b5c48c7f8d988714e1a9;hpb=718fc1767c5534e0606c7ffeb3bb23db6b8d9b0e;p=nonrtric.git 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 944cbf0b..5f61e312 100644 --- 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,15 +58,43 @@ 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 = "
"
- + " 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.
A data consumer can have several active data subscriptions (EI job). One EI job consists of the the type of data to produce and additional parameters for filtering of the data. These parameters are different for different data types."
- + "
" - + " This API is between Near-RT RIC, which is a data consumer and the Non-RT RIC. " + "
" - + "" - + " 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 provides a means to monitor the service." + 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." //
+ + "
" // + + " 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." // + "
"; }