From e020ca3c855ec9555213abfdd89e14d72310177d Mon Sep 17 00:00:00 2001 From: MichaelMorris Date: Thu, 18 Mar 2021 11:40:48 +0000 Subject: Publish swagger files for SDC APIs I have created a swagger file for each of the APIs as they are currently listed on the architecture page. Some of the files can be easily be combined if some of the APIs are combined. I have created a single file for SDCE-2 and SDCE-5 as it is not possible to seperate as they are both paritially implemented in the same class with overlapping paths I have copied the generated swagger files to the docs directory as I suspect they need to be under source control for the generation of the readthedocs page Signed-off-by: MichaelMorris Issue-ID: SDC-3525 Change-Id: Id42412704311a573e3ebf911ad34d909c1c3f1b2 --- .../main/java/org/openecomp/sdcrests/validation/rest/Validation.java | 5 +++-- .../sdcrests/validation/rest/ValidationForSwaggerUsage.java | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main') diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/Validation.java b/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/Validation.java index 18da11561f..ec8c8eb945 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/Validation.java +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/Validation.java @@ -16,8 +16,9 @@ package org.openecomp.sdcrests.validation.rest; -import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.info.Info; +import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import org.apache.cxf.jaxrs.ext.multipart.Multipart; import org.springframework.validation.annotation.Validated; @@ -30,7 +31,7 @@ import java.io.InputStream; @Path("/v1.0/validation") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) -@OpenAPIDefinition(info = @Info(title = ("Validation"))) +@Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Validation")}) @Validated public interface Validation { diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/ValidationForSwaggerUsage.java b/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/ValidationForSwaggerUsage.java index 76b0bad585..e184b9e2a4 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/ValidationForSwaggerUsage.java +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/validation-rest/validation-rest-services/src/main/java/org/openecomp/sdcrests/validation/rest/ValidationForSwaggerUsage.java @@ -17,9 +17,10 @@ package org.openecomp.sdcrests.validation.rest; import com.sun.jersey.multipart.FormDataParam; -import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.info.Info; +import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import org.springframework.validation.annotation.Validated; import javax.ws.rs.*; @@ -31,7 +32,7 @@ import java.io.InputStream; @Path("/v1.0/validation") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) -@OpenAPIDefinition(info = @Info(title="Validation")) +@Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Validation")}) @Validated public interface ValidationForSwaggerUsage { -- cgit 1.2.3-korg