From 63087c615443f982dcf140918070436f446b97f4 Mon Sep 17 00:00:00 2001 From: PatrikBuhr Date: Fri, 12 Feb 2021 16:30:24 +0100 Subject: [PATCH] Uplift of PMS from ONAP Improved API documentation. Signed-off-by: PatrikBuhr Issue-ID: NONRTRIC-415 Change-Id: Ifb50a7cc1acd8957d5a1c1920e37ffac0910df8e --- enrichment-coordinator-service/api/ecs-api.json | 2 +- enrichment-coordinator-service/api/ecs-api.yaml | 4 ++-- .../java/org/oransc/enrichment/SwaggerConfig.java | 21 +++++++++++++++------ onap/oran | 2 +- policy-agent/pom.xml | 16 +++++++++++++--- 5 files changed, 32 insertions(+), 13 deletions(-) diff --git a/enrichment-coordinator-service/api/ecs-api.json b/enrichment-coordinator-service/api/ecs-api.json index c99873b3..237c3c4c 100644 --- a/enrichment-coordinator-service/api/ecs-api.json +++ b/enrichment-coordinator-service/api/ecs-api.json @@ -655,7 +655,7 @@ "name": "Copyright (C) 2020 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 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.<\/p>

APIs provided by the service<\/h2>

A1-EI<\/h4>

This API is between Near-RT RIC, which is a data consumer and the Non-RT RIC. <\/p>

Data producer API<\/h4>

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>

EI Service status<\/h4>

This API provides a means to monitor the service.<\/p>", + "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 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 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, which is a data consumer, and the Non-RT RIC. <\/p>

Data producer API<\/h4>

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>

EI Service status<\/h4>

This API provides a means to monitor the service.<\/p>", "title": "Enrichment Information Service", "version": "1.0" }, diff --git a/enrichment-coordinator-service/api/ecs-api.yaml b/enrichment-coordinator-service/api/ecs-api.yaml index 3b705cff..beb5512d 100644 --- a/enrichment-coordinator-service/api/ecs-api.yaml +++ b/enrichment-coordinator-service/api/ecs-api.yaml @@ -5,10 +5,10 @@ info: 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 + 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.

APIs provided by the service

A1-EI

This - API is between Near-RT RIC, which is a data consumer and the Non-RT RIC.

Data + API is between Near-RT RIC, which is a data consumer, and the Non-RT RIC.

Data producer API

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.

EI Service status

This 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..fdfc0c9e 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 @@ -58,13 +58,22 @@ public class SwaggerConfig { static final String API_TITLE = "Enrichment Data service"; - 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 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." - + "

" + "

APIs provided by the service

" + "

A1-EI

" + "

" - + " This API is between Near-RT RIC, which is a data consumer and the Non-RT RIC. " + "

" - + "

Data producer API

" + "

" + 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 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 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, which is a data consumer, and the Non-RT RIC. " // + + "

" + "

Data producer API

" // + + "

" + " 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." - + "

" + "

EI Service status

" + "

" + " This API provides a means to monitor the service." + + "

" // + + "

EI Service status

" // + + "

" // + + " This API provides a means to monitor the service." // + "

"; } diff --git a/onap/oran b/onap/oran index be0ae3e1..02013b33 160000 --- a/onap/oran +++ b/onap/oran @@ -1 +1 @@ -Subproject commit be0ae3e197f5d5032c0766a59050b03e2a4deb99 +Subproject commit 02013b33111f0b51d07c80c89f4d5d08b60b2099 diff --git a/policy-agent/pom.xml b/policy-agent/pom.xml index d18c9f75..36559e93 100644 --- a/policy-agent/pom.xml +++ b/policy-agent/pom.xml @@ -26,7 +26,7 @@ org.springframework.boot spring-boot-starter-parent - 2.3.4.RELEASE + 2.3.8.RELEASE org.o-ran-sc.nonrtric @@ -47,10 +47,10 @@ 11 - 2.9.2 + 3.0.0 2.8.2 1.1.6 - 2.0.0 + 2.1.6 20190722 3.6 3.8.0 @@ -63,6 +63,16 @@ 0.8.5 + + com.google.guava + guava + 30.0-jre + + + org.springdoc + springdoc-openapi-ui + 1.5.2 + org.springframework.boot spring-boot-starter-web -- 2.16.6