From 62c259621a53b802e8ea2823d6b0fed78e4f6660 Mon Sep 17 00:00:00 2001 From: PatrikBuhr Date: Fri, 25 Mar 2022 15:39:06 +0100 Subject: NONRTRIC Minor changes Some version updated and changes related to swagger documentation generation. Issue-ID: CCSDK-3560 Signed-off-by: PatrikBuhr Change-Id: I59311f5fd09face79e9dce185c65374522dcb40e --- a1-policy-management/api/pms-api.json | 80 ++++++++-------- a1-policy-management/api/pms-api.yaml | 102 ++++++++++----------- a1-policy-management/pom.xml | 9 +- .../a1policymanagementservice/SwaggerConfig.java | 28 ------ .../controllers/v2/ConfigurationController.java | 5 +- .../controllers/v2/PolicyController.java | 5 +- .../controllers/v2/RicRepositoryController.java | 7 +- .../controllers/v2/ServiceController.java | 6 +- .../controllers/v2/StatusController.java | 5 +- .../controllers/v2/RappSimulatorController.java | 5 +- 10 files changed, 121 insertions(+), 131 deletions(-) diff --git a/a1-policy-management/api/pms-api.json b/a1-policy-management/api/pms-api.json index 91ad1b7e..2b8fb739 100644 --- a/a1-policy-management/api/pms-api.json +++ b/a1-policy-management/api/pms-api.json @@ -297,6 +297,15 @@ ], "tags": ["A1 Policy Management"] }}, + "/actuator/threaddump": {"get": { + "summary": "Actuator web endpoint 'threaddump'", + "operationId": "threaddump_2", + "responses": {"200": { + "description": "OK", + "content": {"*/*": {"schema": {"type": "object"}}} + }}, + "tags": ["Actuator"] + }}, "/a1-policy/v2/status": {"get": { "summary": "Returns status and statistics of this service", "operationId": "getStatus", @@ -306,9 +315,18 @@ }}, "tags": ["Health Check"] }}, - "/actuator/threaddump": {"get": { - "summary": "Actuator web endpoint 'threaddump'", - "operationId": "threaddump_4", + "/actuator/loggers": {"get": { + "summary": "Actuator web endpoint 'loggers'", + "operationId": "loggers", + "responses": {"200": { + "description": "OK", + "content": {"*/*": {"schema": {"type": "object"}}} + }}, + "tags": ["Actuator"] + }}, + "/actuator/health/**": {"get": { + "summary": "Actuator web endpoint 'health-path'", + "operationId": "health-path", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -347,24 +365,6 @@ ], "tags": ["NearRT-RIC Repository"] }}, - "/actuator/loggers": {"get": { - "summary": "Actuator web endpoint 'loggers'", - "operationId": "loggers_2", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, - "/actuator/health/**": {"get": { - "summary": "Actuator web endpoint 'health-path'", - "operationId": "health-path_2", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] - }}, "/a1-policy/v2/policy-types": {"get": { "summary": "Query policy type identities", "operationId": "getPolicyTypes", @@ -457,7 +457,7 @@ }, "/actuator/metrics/{requiredMetricName}": {"get": { "summary": "Actuator web endpoint 'metrics-requiredMetricName'", - "operationId": "metrics-requiredMetricName_2", + "operationId": "metrics-requiredMetricName", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -512,7 +512,7 @@ }, "/actuator": {"get": { "summary": "Actuator root web endpoint", - "operationId": "links_1", + "operationId": "links", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": { @@ -528,7 +528,7 @@ "/actuator/loggers/{name}": { "post": { "summary": "Actuator web endpoint 'loggers-name'", - "operationId": "loggers-name_3", + "operationId": "loggers-name", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -543,7 +543,7 @@ }, "get": { "summary": "Actuator web endpoint 'loggers-name'", - "operationId": "loggers-name_4", + "operationId": "loggers-name_2", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -581,7 +581,7 @@ }}, "/actuator/metrics": {"get": { "summary": "Actuator web endpoint 'metrics'", - "operationId": "metrics_2", + "operationId": "metrics", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -662,7 +662,7 @@ }, "/actuator/info": {"get": { "summary": "Actuator web endpoint 'info'", - "operationId": "info_2", + "operationId": "info", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -701,7 +701,7 @@ }}, "/actuator/logfile": {"get": { "summary": "Actuator web endpoint 'logfile'", - "operationId": "logfile_2", + "operationId": "logfile", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -710,7 +710,7 @@ }}, "/actuator/health": {"get": { "summary": "Actuator web endpoint 'health'", - "operationId": "health_2", + "operationId": "health", "responses": {"200": { "description": "OK", "content": {"*/*": {"schema": {"type": "object"}}} @@ -831,6 +831,15 @@ }], "tags": ["Service Registry and Supervision"] }}, + "/actuator/heapdump": {"get": { + "summary": "Actuator web endpoint 'heapdump'", + "operationId": "heapdump", + "responses": {"200": { + "description": "OK", + "content": {"*/*": {"schema": {"type": "object"}}} + }}, + "tags": ["Actuator"] + }}, "/a1-policy/v2/policies/{policy_id}/status": {"get": { "summary": "Returns a policy status", "operationId": "getPolicyStatus", @@ -851,15 +860,6 @@ "required": true }], "tags": ["A1 Policy Management"] - }}, - "/actuator/heapdump": {"get": { - "summary": "Actuator web endpoint 'heapdump'", - "operationId": "heapdump_2", - "responses": {"200": { - "description": "OK", - "content": {"*/*": {"schema": {"type": "object"}}} - }}, - "tags": ["Actuator"] }} }, "info": { @@ -877,7 +877,6 @@ {"name": "NearRT-RIC Repository"}, {"name": "Callbacks"}, {"name": "Health Check"}, - {"name": "Management of configuration"}, { "name": "Actuator", "description": "Monitor and interact", @@ -885,6 +884,7 @@ "description": "Spring Boot Actuator Web API Documentation", "url": "https://docs.spring.io/spring-boot/docs/current/actuator-api/html/" } - } + }, + {"name": "Management of configuration"} ] } \ No newline at end of file diff --git a/a1-policy-management/api/pms-api.yaml b/a1-policy-management/api/pms-api.yaml index 875e2734..958ec0d4 100644 --- a/a1-policy-management/api/pms-api.yaml +++ b/a1-policy-management/api/pms-api.yaml @@ -32,12 +32,12 @@ tags: - name: NearRT-RIC Repository - name: Callbacks - name: Health Check -- name: Management of configuration - name: Actuator description: Monitor and interact externalDocs: description: Spring Boot Actuator Web API Documentation url: https://docs.spring.io/spring-boot/docs/current/actuator-api/html/ +- name: Management of configuration paths: /a1-policy/v2/policy-instances: get: @@ -95,6 +95,19 @@ paths: application/json: schema: $ref: '#/components/schemas/error_information' + /actuator/threaddump: + get: + tags: + - Actuator + summary: Actuator web endpoint 'threaddump' + operationId: threaddump_2 + responses: + 200: + description: OK + content: + '*/*': + schema: + type: object /a1-policy/v2/status: get: tags: @@ -108,12 +121,25 @@ paths: application/json: schema: $ref: '#/components/schemas/status_info_v2' - /actuator/threaddump: + /actuator/loggers: get: tags: - Actuator - summary: Actuator web endpoint 'threaddump' - operationId: threaddump_4 + summary: Actuator web endpoint 'loggers' + operationId: loggers + responses: + 200: + description: OK + content: + '*/*': + schema: + type: object + /actuator/health/**: + get: + tags: + - Actuator + summary: Actuator web endpoint 'health-path' + operationId: health-path responses: 200: description: OK @@ -161,32 +187,6 @@ paths: application/json: schema: $ref: '#/components/schemas/error_information' - /actuator/loggers: - get: - tags: - - Actuator - summary: Actuator web endpoint 'loggers' - operationId: loggers_2 - responses: - 200: - description: OK - content: - '*/*': - schema: - type: object - /actuator/health/**: - get: - tags: - - Actuator - summary: Actuator web endpoint 'health-path' - operationId: health-path_2 - responses: - 200: - description: OK - content: - '*/*': - schema: - type: object /a1-policy/v2/policy-types: get: tags: @@ -305,7 +305,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'metrics-requiredMetricName' - operationId: metrics-requiredMetricName_2 + operationId: metrics-requiredMetricName parameters: - name: requiredMetricName in: path @@ -376,7 +376,7 @@ paths: tags: - Actuator summary: Actuator root web endpoint - operationId: links_1 + operationId: links responses: 200: description: OK @@ -393,7 +393,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'loggers-name' - operationId: loggers-name_4 + operationId: loggers-name_2 parameters: - name: name in: path @@ -413,7 +413,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'loggers-name' - operationId: loggers-name_3 + operationId: loggers-name parameters: - name: name in: path @@ -464,7 +464,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'metrics' - operationId: metrics_2 + operationId: metrics responses: 200: description: OK @@ -571,7 +571,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'info' - operationId: info_2 + operationId: info responses: 200: description: OK @@ -624,7 +624,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'logfile' - operationId: logfile_2 + operationId: logfile responses: 200: description: OK @@ -637,7 +637,7 @@ paths: tags: - Actuator summary: Actuator web endpoint 'health' - operationId: health_2 + operationId: health responses: 200: description: OK @@ -790,6 +790,19 @@ paths: '*/*': schema: $ref: '#/components/schemas/error_information' + /actuator/heapdump: + get: + tags: + - Actuator + summary: Actuator web endpoint 'heapdump' + operationId: heapdump + responses: + 200: + description: OK + content: + '*/*': + schema: + type: object /a1-policy/v2/policies/{policy_id}/status: get: tags: @@ -817,19 +830,6 @@ paths: application/json: schema: $ref: '#/components/schemas/error_information' - /actuator/heapdump: - get: - tags: - - Actuator - summary: Actuator web endpoint 'heapdump' - operationId: heapdump_2 - responses: - 200: - description: OK - content: - '*/*': - schema: - type: object components: schemas: error_information: diff --git a/a1-policy-management/pom.xml b/a1-policy-management/pom.xml index c2d2804d..301b4ab4 100644 --- a/a1-policy-management/pom.xml +++ b/a1-policy-management/pom.xml @@ -35,9 +35,8 @@ 11 11 3.0.0 - - 2.8.8 - 20211205 + 2.9.0 + 20220320 2.13.0 2.5.0 2.11.0 @@ -53,7 +52,7 @@ org.springdoc springdoc-openapi-ui - 1.6.3 + 1.6.6 org.springframework.boot @@ -225,7 +224,7 @@ com.github.erosb everit-json-schema - 1.13.0 + 1.14.0 diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java index 6d56c679..b262af07 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/SwaggerConfig.java @@ -23,7 +23,6 @@ package org.onap.ccsdk.oran.a1policymanagementservice; import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.info.Info; import io.swagger.v3.oas.annotations.info.License; -import io.swagger.v3.oas.annotations.tags.Tag; import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.ConfigurationController; import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.Consts; @@ -40,33 +39,6 @@ import org.onap.ccsdk.oran.a1policymanagementservice.controllers.v2.StatusContro * */ @OpenAPIDefinition( // - tags = { // - @Tag(// - name = ConfigurationController.API_NAME, // - description = ConfigurationController.API_DESCRIPTION // - ), // - @Tag(// - name = PolicyController.API_NAME, // - description = PolicyController.API_DESCRIPTION // - ), // - @Tag( // - name = RicRepositoryController.API_NAME, // - description = RicRepositoryController.API_DESCRIPTION // - ), // - @Tag( // - name = ServiceController.API_NAME, // - description = ServiceController.API_DESCRIPTION // - - ), // - @Tag( // - name = StatusController.API_NAME, // - description = StatusController.API_DESCRIPTION // - ), // - @Tag( // - name = Consts.V2_API_SERVICE_CALLBACKS_NAME, // - description = Consts.V2_API_SERVICE_CALLBACKS_DESCRIPTION // - ) // - }, // info = @Info(title = SwaggerConfig.API_TITLE, // version = SwaggerConfig.VERSION, // description = SwaggerConfig.DESCRIPTION, // diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ConfigurationController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ConfigurationController.java index 7a65bacb..c8d9e4c7 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ConfigurationController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ConfigurationController.java @@ -49,7 +49,10 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; @RestController("ConfigurationControllerV2") -@Tag(name = ConfigurationController.API_NAME) +@Tag( // + name = ConfigurationController.API_NAME, // + description = ConfigurationController.API_DESCRIPTION // +) public class ConfigurationController { private static final Logger logger = LoggerFactory.getLogger(ConfigurationController.class); diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java index 125b75a3..62018424 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/PolicyController.java @@ -70,7 +70,10 @@ import org.springframework.web.reactive.function.client.WebClientResponseExcepti import reactor.core.publisher.Mono; @RestController("PolicyControllerV2") -@Tag(name = PolicyController.API_NAME) +@Tag(// + name = PolicyController.API_NAME, // + description = PolicyController.API_DESCRIPTION // +) public class PolicyController { public static final String API_NAME = "A1 Policy Management"; diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java index a531a73f..def388ac 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RicRepositoryController.java @@ -48,7 +48,10 @@ import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController("RicRepositoryControllerV2") -@Tag(name = RicRepositoryController.API_NAME) +@Tag( // + name = RicRepositoryController.API_NAME, // + description = RicRepositoryController.API_DESCRIPTION // +) public class RicRepositoryController { public static final String API_NAME = "NearRT-RIC Repository"; @@ -70,7 +73,7 @@ public class RicRepositoryController { /** * Example: http://localhost:8081/v2/rics/ric?managed_element_id=kista_1 - * + * * @throws EntityNotFoundException */ @GetMapping(path = Consts.V2_API_ROOT + "/rics/ric", produces = MediaType.APPLICATION_JSON_VALUE) diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java index 375f92f9..7f342150 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/ServiceController.java @@ -56,7 +56,11 @@ import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; @RestController("ServiceControllerV2") -@Tag(name = ServiceController.API_NAME) +@Tag( // + name = ServiceController.API_NAME, // + description = ServiceController.API_DESCRIPTION // + +) public class ServiceController { public static final String API_NAME = "Service Registry and Supervision"; diff --git a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/StatusController.java b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/StatusController.java index cbdde961..df9dfd19 100644 --- a/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/StatusController.java +++ b/a1-policy-management/src/main/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/StatusController.java @@ -36,7 +36,10 @@ import org.springframework.web.bind.annotation.RestController; import reactor.core.publisher.Mono; @RestController("StatusControllerV2") -@Tag(name = StatusController.API_NAME) +@Tag( // + name = StatusController.API_NAME, // + description = StatusController.API_DESCRIPTION // +) public class StatusController { public static final String API_NAME = "Health Check"; diff --git a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RappSimulatorController.java b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RappSimulatorController.java index e5998346..1fa51246 100644 --- a/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RappSimulatorController.java +++ b/a1-policy-management/src/test/java/org/onap/ccsdk/oran/a1policymanagementservice/controllers/v2/RappSimulatorController.java @@ -47,7 +47,10 @@ import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RestController; @RestController("RappCallbacksController") -@Tag(name = Consts.V2_API_SERVICE_CALLBACKS_NAME) +@Tag( // + name = Consts.V2_API_SERVICE_CALLBACKS_NAME, // + description = Consts.V2_API_SERVICE_CALLBACKS_DESCRIPTION // +) public class RappSimulatorController { private final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass()); -- cgit 1.2.3-korg