Improved API documentation.
Signed-off-by: PatrikBuhr <patrik.buhr@est.tech>
Issue-ID: NONRTRIC-415
Change-Id: Ifb50a7cc1acd8957d5a1c1920e37ffac0910df8e
"name": "Copyright (C) 2020 Nordix Foundation. Licensed under the Apache License.",
"url": "http://www.apache.org/licenses/LICENSE-2.0"
},
- "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 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.<\/p><h4>EI Service status<\/h4><p> This API provides a means to monitor the service.<\/p>",
+ "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.<\/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.<\/p><h4>EI Service status<\/h4><p> This API provides a means to monitor the service.<\/p>",
"title": "Enrichment Information Service",
"version": "1.0"
},
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 the type of data to produce
+ 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
+ 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.</p><h4>EI Service status</h4><p> This
static final String API_TITLE = "Enrichment Data service";
- 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 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>"
+ 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." //
+ + "</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."
- + "</p>" + "<h4>EI Service status</h4>" + "<p>" + " This API provides a means to monitor the service."
+ + "</p>" //
+ + "<h4>EI Service status</h4>" //
+ + "<p>" //
+ + " This API provides a means to monitor the service." //
+ "</p>";
}
-Subproject commit be0ae3e197f5d5032c0766a59050b03e2a4deb99
+Subproject commit 02013b33111f0b51d07c80c89f4d5d08b60b2099
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
- <version>2.3.4.RELEASE</version>
+ <version>2.3.8.RELEASE</version>
<relativePath />
</parent>
<groupId>org.o-ran-sc.nonrtric</groupId>
</repositories>
<properties>
<java.version>11</java.version>
- <springfox.version>2.9.2</springfox.version>
+ <springfox.version>3.0.0</springfox.version>
<immutable.version>2.8.2</immutable.version>
<sdk.version>1.1.6</sdk.version>
- <swagger.version>2.0.0</swagger.version>
+ <swagger.version>2.1.6</swagger.version>
<json.version>20190722</json.version>
<commons-net.version>3.6</commons-net.version>
<maven-compiler-plugin.version>3.8.0</maven-compiler-plugin.version>
<jacoco-maven-plugin.version>0.8.5</jacoco-maven-plugin.version>
</properties>
<dependencies>
+ <dependency>
+ <groupId>com.google.guava</groupId>
+ <artifactId>guava</artifactId>
+ <version>30.0-jre</version>
+ </dependency>
+ <dependency>
+ <groupId>org.springdoc</groupId>
+ <artifactId>springdoc-openapi-ui</artifactId>
+ <version>1.5.2</version>
+ </dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>