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 --- .../src/main/java/org/openecomp/sdcrests/item/rest/Items.java | 5 +++-- .../src/main/java/org/openecomp/sdcrests/item/rest/Versions.java | 5 +++-- 2 files changed, 6 insertions(+), 4 deletions(-) (limited to 'openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item') diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Items.java b/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Items.java index a916f8df55..ae8e095acb 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Items.java +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Items.java @@ -15,7 +15,6 @@ */ package org.openecomp.sdcrests.item.rest; -import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.info.Info; @@ -23,6 +22,8 @@ import io.swagger.v3.oas.annotations.media.ArraySchema; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import org.openecomp.sdc.versioning.types.Item; import org.openecomp.sdcrests.item.types.ItemActionRequestDto; import org.springframework.validation.annotation.Validated; @@ -39,7 +40,7 @@ import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG @Path("/v1.0/items") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) -@OpenAPIDefinition(info = @Info(title = "Items")) +@Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Items")}) @Validated public interface Items { diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Versions.java b/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Versions.java index 6f72175175..edc0596282 100644 --- a/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Versions.java +++ b/openecomp-be/api/openecomp-sdc-rest-webapp/item-rest/item-rest-services/src/main/java/org/openecomp/sdcrests/item/rest/Versions.java @@ -20,7 +20,6 @@ package org.openecomp.sdcrests.item.rest; -import io.swagger.v3.oas.annotations.OpenAPIDefinition; import io.swagger.v3.oas.annotations.Operation; import io.swagger.v3.oas.annotations.Parameter; import io.swagger.v3.oas.annotations.info.Info; @@ -28,6 +27,8 @@ import io.swagger.v3.oas.annotations.media.ArraySchema; import io.swagger.v3.oas.annotations.media.Content; import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; +import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import org.openecomp.sdcrests.item.types.*; import org.springframework.validation.annotation.Validated; @@ -42,7 +43,7 @@ import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG @Path("/v1.0/items/{itemId}/versions") @Produces(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON) -@OpenAPIDefinition(info = @Info(title = "Item Versions")) +@Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Item Versions")}) @Validated public interface Versions { -- cgit 1.2.3-korg