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 --- catalog-be/pom.xml | 62 ++++++++++++++++++++++ .../servlet/DistributionCatalogServlet.java | 2 +- .../distribution/servlet/DistributionServlet.java | 2 +- .../servlet/AbstractTemplateServlet.java | 2 +- .../servlet/ArtifactExternalServlet.java | 2 +- .../be/externalapi/servlet/AssetsDataServlet.java | 2 +- .../externalapi/servlet/CrudExternalServlet.java | 2 +- .../externalapi/servlet/ExternalRefsServlet.java | 2 +- .../servlet/ServiceActivationServlet.java | 2 +- .../be/servlets/AdditionalInformationServlet.java | 2 +- .../openecomp/sdc/be/servlets/ArchiveEndpoint.java | 2 +- .../openecomp/sdc/be/servlets/ArtifactServlet.java | 2 +- .../sdc/be/servlets/AttributeServlet.java | 3 +- .../sdc/be/servlets/AutomatedUpgradeEndpoint.java | 2 +- .../sdc/be/servlets/BeGenericServlet.java | 5 -- .../sdc/be/servlets/BeMonitoringServlet.java | 3 +- .../sdc/be/servlets/CapabilityServlet.java | 2 +- .../sdc/be/servlets/ComponentAttributeServlet.java | 3 +- .../sdc/be/servlets/ComponentInstanceServlet.java | 3 +- .../ComponentInterfaceOperationServlet.java | 3 ++ .../be/servlets/ComponentNodeFilterServlet.java | 3 ++ .../sdc/be/servlets/ComponentPropertyServlet.java | 2 +- .../sdc/be/servlets/ComponentServlet.java | 2 +- .../ComponentSubstitutionFilterServlet.java | 3 ++ .../sdc/be/servlets/ConfigMgrServlet.java | 2 +- .../openecomp/sdc/be/servlets/ConfigServlet.java | 2 +- .../openecomp/sdc/be/servlets/ConsumerServlet.java | 2 +- .../sdc/be/servlets/DirectiveServlet.java | 3 ++ .../be/servlets/DistributionServiceServlet.java | 2 +- .../openecomp/sdc/be/servlets/ElementServlet.java | 2 +- .../sdc/be/servlets/ExceptionHandlerEndpoint.java | 2 +- .../be/servlets/GenericArtifactBrowserServlet.java | 2 +- .../openecomp/sdc/be/servlets/GroupEndpoint.java | 2 +- .../openecomp/sdc/be/servlets/GroupServlet.java | 2 +- .../sdc/be/servlets/GroupTypesEndpoint.java | 2 +- .../openecomp/sdc/be/servlets/InputsServlet.java | 3 +- .../sdc/be/servlets/InterfaceOperationServlet.java | 2 +- .../sdc/be/servlets/LifecycleServlet.java | 2 +- .../openecomp/sdc/be/servlets/OutputsServlet.java | 3 +- .../openecomp/sdc/be/servlets/PolicyServlet.java | 2 +- .../sdc/be/servlets/PolicyTypesEndpoint.java | 2 +- .../sdc/be/servlets/RequirementServlet.java | 2 +- .../sdc/be/servlets/ResourceUploadServlet.java | 2 +- .../sdc/be/servlets/ResourcesServlet.java | 2 +- .../sdc/be/servlets/ServiceConsumptionServlet.java | 2 +- .../be/servlets/ServiceForwardingPathServlet.java | 2 +- .../openecomp/sdc/be/servlets/ServiceServlet.java | 16 +++++- .../sdc/be/servlets/ServiceUploadServlet.java | 2 +- .../openecomp/sdc/be/servlets/TogglingServlet.java | 2 +- .../sdc/be/servlets/TypesFetchServlet.java | 2 +- .../sdc/be/servlets/TypesUploadEndpoint.java | 2 +- .../sdc/be/servlets/TypesUploadServlet.java | 2 +- .../sdc/be/servlets/UserAdminServlet.java | 2 +- .../resources/swagger-config/sdce-2-sdce-5.yaml | 21 ++++++++ .../src/main/resources/swagger-config/sdce-4.yaml | 19 +++++++ .../src/main/resources/swagger-config/sdce-6.yaml | 19 +++++++ .../src/main/resources/swagger-config/sdce-7.yaml | 25 +++++++++ 57 files changed, 225 insertions(+), 52 deletions(-) create mode 100644 catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml create mode 100644 catalog-be/src/main/resources/swagger-config/sdce-4.yaml create mode 100644 catalog-be/src/main/resources/swagger-config/sdce-6.yaml create mode 100644 catalog-be/src/main/resources/swagger-config/sdce-7.yaml (limited to 'catalog-be') diff --git a/catalog-be/pom.xml b/catalog-be/pom.xml index 6a7b5a984d..2bb28627d5 100644 --- a/catalog-be/pom.xml +++ b/catalog-be/pom.xml @@ -1029,6 +1029,68 @@ + + io.swagger.core.v3 + swagger-maven-plugin + + + sdce-2-sdce-5 + compile + + resolve + + + sdce-2-sdce-5 + ${project.build.directory}/generated/swagger + swagger-sdce-2-sdce-5 + JSON + ${project.basedir}/src/main/resources/swagger-config/sdce-2-sdce-5.yaml + + + + sdce-4 + compile + + resolve + + + sdce-4 + ${project.build.directory}/generated/swagger + swagger-sdce-4 + JSON + ${project.basedir}/src/main/resources/swagger-config/sdce-4.yaml + + + + sdce-6 + compile + + resolve + + + sdce-6 + ${project.build.directory}/generated/swagger + swagger-sdce-6 + JSON + ${project.basedir}/src/main/resources/swagger-config/sdce-6.yaml + + + + sdce-7 + compile + + resolve + + + sdce-7 + ${project.build.directory}/generated/swagger + swagger-sdce-7 + JSON + ${project.basedir}/src/main/resources/swagger-config/sdce-7.yaml + + + + diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionCatalogServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionCatalogServlet.java index e0fb33534f..805d336775 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionCatalogServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionCatalogServlet.java @@ -70,7 +70,7 @@ import org.openecomp.sdc.exception.ResponseFormat; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Distribution APIs")}) +@Tags({@Tag(name = "SDCE-7 APIs")}) @Servers({@Server(url = "/sdc")}) @Singleton public class DistributionCatalogServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionServlet.java index 511e9971c7..ee28d948e0 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/distribution/servlet/DistributionServlet.java @@ -73,7 +73,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1") -@Tags({@Tag(name = "SDC Distribution APIs")}) +@Tags({@Tag(name = "SDCE-6 APIs")}) @Servers({@Server(url = "/sdc")}) @Controller public class DistributionServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AbstractTemplateServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AbstractTemplateServlet.java index 17819de71e..f7329c6e8a 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AbstractTemplateServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AbstractTemplateServlet.java @@ -78,7 +78,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC External APIs") +@Tag(name = "SDCE-7 APIs") @Server(url = "/sdc") @Controller public class AbstractTemplateServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ArtifactExternalServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ArtifactExternalServlet.java index f4615ab9c5..2bb28dd2f5 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ArtifactExternalServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ArtifactExternalServlet.java @@ -81,7 +81,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC External APIs") +@Tag(name = "SDCE-7 APIs") @Server(url = "/sdc") @Controller public class ArtifactExternalServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AssetsDataServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AssetsDataServlet.java index 1c8f15042a..c3edca5544 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AssetsDataServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/AssetsDataServlet.java @@ -91,7 +91,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC External APIs")}) +@Tags({@Tag(name = "SDCE-7 APIs")}) @Servers({@Server(url = "/sdc")}) @Controller public class AssetsDataServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/CrudExternalServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/CrudExternalServlet.java index 5f6d8eaeda..3f0c049fb0 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/CrudExternalServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/CrudExternalServlet.java @@ -98,7 +98,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC External APIs") +@Tag(name = "SDCE-7 APIs") @Server(url = "/sdc") @Controller public class CrudExternalServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ExternalRefsServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ExternalRefsServlet.java index f93e99eecd..f57ee48504 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ExternalRefsServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ExternalRefsServlet.java @@ -53,7 +53,7 @@ import org.openecomp.sdc.common.log.wrappers.Logger; import org.springframework.stereotype.Controller; @Path("/v1/catalog") -@Tags({@Tag(name = "SDC External APIs")}) +@Tags({@Tag(name = "SDCE-7 APIs")}) @Servers({@Server(url = "/sdc")}) @Controller public class ExternalRefsServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ServiceActivationServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ServiceActivationServlet.java index d203415ae5..76d523d67f 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ServiceActivationServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/externalapi/servlet/ServiceActivationServlet.java @@ -68,7 +68,7 @@ import org.springframework.stereotype.Controller; @SuppressWarnings("ALL") @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC External APIs") +@Tag(name = "SDCE-7 APIs") @Server(url = "/sdc") @Controller public class ServiceActivationServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AdditionalInformationServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AdditionalInformationServlet.java index d9e5aed187..06e32b754e 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AdditionalInformationServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AdditionalInformationServlet.java @@ -63,7 +63,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class AdditionalInformationServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArchiveEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArchiveEndpoint.java index f2930615be..f3fd56baa3 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArchiveEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArchiveEndpoint.java @@ -59,7 +59,7 @@ import org.springframework.web.bind.annotation.RequestBody; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArtifactServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArtifactServlet.java index 93f9fff931..ad0f548523 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArtifactServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ArtifactServlet.java @@ -73,7 +73,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ArtifactServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AttributeServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AttributeServlet.java index c9af80624a..14ce955419 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AttributeServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AttributeServlet.java @@ -30,6 +30,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.io.IOException; import javax.inject.Inject; import javax.servlet.ServletContext; @@ -71,7 +72,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Controller public class AttributeServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AutomatedUpgradeEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AutomatedUpgradeEndpoint.java index 8a16c43e10..7bee732fa7 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AutomatedUpgradeEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/AutomatedUpgradeEndpoint.java @@ -58,7 +58,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeGenericServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeGenericServlet.java index 43f51664b5..1eb4d28e0e 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeGenericServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeGenericServlet.java @@ -27,9 +27,6 @@ import com.google.gson.Gson; import com.google.gson.GsonBuilder; import com.google.gson.reflect.TypeToken; import fj.data.Either; -import io.swagger.v3.oas.annotations.OpenAPIDefinition; -import io.swagger.v3.oas.annotations.info.Info; -import io.swagger.v3.oas.annotations.servers.Server; import java.io.IOException; import java.lang.reflect.Type; import java.util.HashMap; @@ -84,8 +81,6 @@ import org.openecomp.sdc.common.servlets.BasicServlet; import org.openecomp.sdc.exception.ResponseFormat; import org.springframework.web.context.WebApplicationContext; -@OpenAPIDefinition(info = @Info(title = "SDC API", description = "SDC External, Distribution and Internal APIs"), servers = { - @Server(url = "/sdc", description = "SDC External and Distribution APIs"), @Server(url = "/sdc2/rest", description = "SDC Internal APIs")}) public class BeGenericServlet extends BasicServlet { private static final Logger log = Logger.getLogger(BeGenericServlet.class); diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeMonitoringServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeMonitoringServlet.java index afb037fee0..5c7d88be0f 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeMonitoringServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/BeMonitoringServlet.java @@ -29,6 +29,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.util.List; import javax.inject.Inject; import javax.servlet.ServletContext; @@ -54,7 +55,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.TRACE, trim = false) @Path("/") -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Controller public class BeMonitoringServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/CapabilityServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/CapabilityServlet.java index 3470d9f92b..bfa6798b20 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/CapabilityServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/CapabilityServlet.java @@ -68,7 +68,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class CapabilityServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentAttributeServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentAttributeServlet.java index 461ddef031..bfde7a334d 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentAttributeServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentAttributeServlet.java @@ -29,6 +29,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.util.List; import javax.inject.Inject; import javax.inject.Singleton; @@ -57,7 +58,7 @@ import org.slf4j.LoggerFactory; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Singleton public class ComponentAttributeServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInstanceServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInstanceServlet.java index 84cb10b2cb..551540023b 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInstanceServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInstanceServlet.java @@ -35,6 +35,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.io.IOException; import java.io.InputStream; import java.lang.reflect.Type; @@ -110,7 +111,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Controller public class ComponentInstanceServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInterfaceOperationServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInterfaceOperationServlet.java index 4d94ffc8d7..8f580382d2 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInterfaceOperationServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentInterfaceOperationServlet.java @@ -27,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 java.io.IOException; import java.util.Optional; import javax.servlet.http.HttpServletRequest; @@ -65,6 +67,7 @@ import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; @Path("/v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/interfaceOperation") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Controller diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentNodeFilterServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentNodeFilterServlet.java index 0e2b28529d..526dcad7ce 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentNodeFilterServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentNodeFilterServlet.java @@ -24,6 +24,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 java.util.Optional; import javax.inject.Inject; import javax.inject.Singleton; @@ -63,6 +65,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Path("/v1/catalog/{componentType}/{componentId}/componentInstance/{componentInstanceId}/{constraintType}") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Singleton diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentPropertyServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentPropertyServlet.java index 9ff155f6da..6d82e2b239 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentPropertyServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentPropertyServlet.java @@ -66,7 +66,7 @@ import org.slf4j.LoggerFactory; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Singleton public class ComponentPropertyServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentServlet.java index 28ebfd42d1..2df63a2124 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentServlet.java @@ -80,7 +80,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ComponentServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentSubstitutionFilterServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentSubstitutionFilterServlet.java index f12fbd761d..067e68bcb8 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentSubstitutionFilterServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ComponentSubstitutionFilterServlet.java @@ -24,6 +24,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 java.util.List; import java.util.Optional; import javax.inject.Inject; @@ -64,6 +66,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Path("/v1/catalog/{componentType}/{componentId}/substitutionFilter/{constraintType}") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Singleton diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigMgrServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigMgrServlet.java index 9249d21dc3..7e659948fe 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigMgrServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigMgrServlet.java @@ -47,7 +47,7 @@ import org.openecomp.sdc.common.servlets.BasicServlet; * Root resource (exposed at "/" path) */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Path("/configmgr") public class ConfigMgrServlet extends BasicServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigServlet.java index 1c90ea0747..8c94253292 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConfigServlet.java @@ -48,7 +48,7 @@ import org.openecomp.sdc.common.servlets.BasicServlet; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/config") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) public class ConfigServlet extends BasicServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java index 4b31cb1371..75f362b976 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ConsumerServlet.java @@ -61,7 +61,7 @@ import org.openecomp.sdc.exception.ResponseFormat; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/consumers") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Singleton public class ConsumerServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java index d1cee1bf6e..5491201ed8 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DirectiveServlet.java @@ -23,6 +23,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 java.util.HashMap; import java.util.List; import java.util.Map; @@ -50,6 +52,7 @@ import org.slf4j.Logger; import org.slf4j.LoggerFactory; @Path("/v1/catalog/directives") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Singleton public class DirectiveServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DistributionServiceServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DistributionServiceServlet.java index 20a1df2ac3..6932448024 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DistributionServiceServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/DistributionServiceServlet.java @@ -60,7 +60,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-5 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class DistributionServiceServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java index e0382c0885..395c610e34 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ElementServlet.java @@ -90,7 +90,7 @@ import org.springframework.stereotype.Controller; * */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) -@Tags({@io.swagger.v3.oas.annotations.tags.Tag(name = "SDC Internal APIs")}) +@Tags({@io.swagger.v3.oas.annotations.tags.Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ElementServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ExceptionHandlerEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ExceptionHandlerEndpoint.java index ff31aa597d..ddd9571ab6 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ExceptionHandlerEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ExceptionHandlerEndpoint.java @@ -43,7 +43,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Produces(MediaType.APPLICATION_JSON) @Controller diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GenericArtifactBrowserServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GenericArtifactBrowserServlet.java index df83035eef..37c754de59 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GenericArtifactBrowserServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GenericArtifactBrowserServlet.java @@ -59,7 +59,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog/gab") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class GenericArtifactBrowserServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupEndpoint.java index 7b2b22e793..7475817283 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupEndpoint.java @@ -60,7 +60,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupServlet.java index 0dcbf8cc14..63afee57a0 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupServlet.java @@ -73,7 +73,7 @@ import org.springframework.stereotype.Controller; @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class GroupServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupTypesEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupTypesEndpoint.java index afce970cb7..f2cd4eee38 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupTypesEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/GroupTypesEndpoint.java @@ -51,7 +51,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InputsServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InputsServlet.java index 96a8a70954..144c19ee26 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InputsServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InputsServlet.java @@ -31,6 +31,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.io.IOException; import java.util.Arrays; import java.util.List; @@ -82,7 +83,7 @@ import org.openecomp.sdc.exception.ResponseFormat; import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Path("/v1/catalog") @Controller diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InterfaceOperationServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InterfaceOperationServlet.java index 1fd31db6ed..7eb3c8ad2a 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InterfaceOperationServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/InterfaceOperationServlet.java @@ -73,7 +73,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class InterfaceOperationServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/LifecycleServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/LifecycleServlet.java index de66aa68f0..77b36f0d48 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/LifecycleServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/LifecycleServlet.java @@ -71,7 +71,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-4 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class LifecycleServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/OutputsServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/OutputsServlet.java index eb75825f42..dae80ba082 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/OutputsServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/OutputsServlet.java @@ -29,6 +29,7 @@ import io.swagger.v3.oas.annotations.media.Schema; import io.swagger.v3.oas.annotations.responses.ApiResponse; import io.swagger.v3.oas.annotations.servers.Server; import io.swagger.v3.oas.annotations.tags.Tag; +import io.swagger.v3.oas.annotations.tags.Tags; import java.util.List; import javax.inject.Inject; import javax.servlet.ServletContext; @@ -68,7 +69,7 @@ import org.openecomp.sdc.exception.ResponseFormat; import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) -@Tag(name = "SDC Internal APIs") +@Tags({@Tag(name = "SDCE-2 APIs")}) @Server(url = "/sdc2/rest") @Path("/v1/catalog") @Controller diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java index eaa9af4669..a7bd4b62b2 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyServlet.java @@ -81,7 +81,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyTypesEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyTypesEndpoint.java index 2dcbda499c..4732780be9 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyTypesEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/PolicyTypesEndpoint.java @@ -52,7 +52,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller @Consumes(MediaType.APPLICATION_JSON) diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RequirementServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RequirementServlet.java index 6164cd1f08..fcfe37ac11 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RequirementServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/RequirementServlet.java @@ -67,7 +67,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class RequirementServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourceUploadServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourceUploadServlet.java index ebe3472d8b..9cf8f67089 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourceUploadServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourceUploadServlet.java @@ -68,7 +68,7 @@ import org.springframework.stereotype.Controller; */ @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog/upload") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ResourceUploadServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourcesServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourcesServlet.java index 9377820d43..81d0f32a3f 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourcesServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ResourcesServlet.java @@ -91,7 +91,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ResourcesServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceConsumptionServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceConsumptionServlet.java index 27117fa3e4..f6dc2973a5 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceConsumptionServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceConsumptionServlet.java @@ -78,7 +78,7 @@ import org.slf4j.LoggerFactory; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Singleton public class ServiceConsumptionServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceForwardingPathServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceForwardingPathServlet.java index 652dfa082d..169e1cf7e7 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceForwardingPathServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceForwardingPathServlet.java @@ -77,7 +77,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog/services/{serviceId}/paths") @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ServiceForwardingPathServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceServlet.java index 1affe7592c..bf171c2042 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceServlet.java @@ -98,7 +98,6 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class ServiceServlet extends AbstractValidationsServlet { @@ -121,6 +120,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @POST @Path("/services") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Create Service", method = "POST", summary = "Returns created service", responses = { @@ -160,6 +160,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @GET @Path("/services/validate-name/{serviceName}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "validate service name", method = "GET", summary = "checks if the chosen service name is available ", responses = { @@ -190,6 +191,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @GET @Path("/audit-records/{componentType}/{componentUniqueId}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "get component audit records", method = "GET", summary = "get audit records for a service or a resource", responses = { @@ -260,6 +262,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @DELETE @Path("/services/{serviceId}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Operation(description = "Delete Service", method = "DELETE", summary = "Return no content", responses = { @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Service.class)))), @ApiResponse(responseCode = "204", description = "Service deleted"), @ApiResponse(responseCode = "403", description = "Restricted operation"), @@ -298,6 +301,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @DELETE @Path("/services/{serviceName}/{version}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Operation(description = "Delete Service By Name And Version", method = "DELETE", summary = "Returns no content", responses = { @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Resource.class)))), @ApiResponse(responseCode = "204", description = "Service deleted"), @ApiResponse(responseCode = "403", description = "Restricted operation"), @@ -334,6 +338,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @PUT @Path("/services/{serviceId}/metadata") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Update Service Metadata", method = "PUT", summary = "Returns updated service", responses = { @@ -387,6 +392,7 @@ public class ServiceServlet extends AbstractValidationsServlet { */ @PUT @Path("/{containerComponentType}/{serviceId}/resourceInstance/{componentInstanceId}/groupInstance/{groupInstanceId}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Update Group Instance Property Values", method = "PUT", summary = "Returns updated group instance", responses = { @@ -439,6 +445,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @GET @Path("/services/{serviceId}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Retrieve Service", method = "GET", summary = "Returns service according to serviceId", responses = { @@ -474,6 +481,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @GET @Path("/services/serviceName/{serviceName}/serviceVersion/{serviceVersion}") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Retrieve Service", method = "GET", summary = "Returns service according to name and version", responses = { @@ -505,6 +513,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @POST @Path("/services/{serviceId}/distribution/{env}/activate") + @Tags({@Tag(name = "SDCE-5 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Activate distribution", method = "POST", summary = "activate distribution", responses = { @@ -540,6 +549,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @POST @Path("/services/{serviceId}/distribution/{did}/markDeployed") + @Tags({@Tag(name = "SDCE-5 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Mark distribution as deployed", method = "POST", summary = "relevant audit record will be created", responses = { @@ -576,6 +586,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @POST @Path("/services/{serviceId}/tempUrlToBeDeleted") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(responses = {@ApiResponse(responseCode = "200", description = "OK"), @@ -606,6 +617,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @GET @Path("/services/{serviceId}/linksMap") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Retrieve Service component relations map", method = "GET", summary = "Returns service components relations", responses = { @@ -641,6 +653,7 @@ public class ServiceServlet extends AbstractValidationsServlet { @POST @Path("/services/importService") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Consumes(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Import Service", method = "POST", summary = "Returns imported service", responses = { @@ -702,6 +715,7 @@ public class ServiceServlet extends AbstractValidationsServlet { */ @POST @Path("/services/serviceUUID/{uuid}/importReplaceService") + @Tags({@Tag(name = "SDCE-2 APIs")}) @Produces(MediaType.APPLICATION_JSON) @Operation(description = "Import Service", method = "POST", summary = "Returns imported service", responses = { @ApiResponse(responseCode = "201", description = "Service created"), @ApiResponse(responseCode = "403", description = "Restricted operation"), diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceUploadServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceUploadServlet.java index 20a259dad6..c7dd825f59 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceUploadServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/ServiceUploadServlet.java @@ -38,7 +38,7 @@ import org.openecomp.sdc.common.log.wrappers.Logger; //upload Service model by Shiyong1989@hotmail.com @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog/uploadservice") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Singleton public class ServiceUploadServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TogglingServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TogglingServlet.java index 884cbcc1e3..bc5036f1ac 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TogglingServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TogglingServlet.java @@ -53,7 +53,7 @@ import org.openecomp.sdc.common.log.wrappers.Logger; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog/toggle") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Singleton public class TogglingServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesFetchServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesFetchServlet.java index 7683f6961d..85f3a8a907 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesFetchServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesFetchServlet.java @@ -78,7 +78,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/catalog") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class TypesFetchServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadEndpoint.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadEndpoint.java index 8d3f58e665..1a8f40927d 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadEndpoint.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadEndpoint.java @@ -67,7 +67,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog/uploadType") @Consumes(MediaType.MULTIPART_FORM_DATA) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class TypesUploadEndpoint extends BeGenericServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadServlet.java index 9e945d613f..d98928c4e4 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/TypesUploadServlet.java @@ -86,7 +86,7 @@ import org.springframework.stereotype.Controller; @Path("/v1/catalog/uploadType") @Consumes(MediaType.MULTIPART_FORM_DATA) @Produces(MediaType.APPLICATION_JSON) -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class TypesUploadServlet extends AbstractValidationsServlet { diff --git a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/UserAdminServlet.java b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/UserAdminServlet.java index 84a88f3b58..2e96b0b77e 100644 --- a/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/UserAdminServlet.java +++ b/catalog-be/src/main/java/org/openecomp/sdc/be/servlets/UserAdminServlet.java @@ -61,7 +61,7 @@ import org.springframework.stereotype.Controller; @Loggable(prepend = true, value = Loggable.DEBUG, trim = false) @Path("/v1/user") -@Tags({@Tag(name = "SDC Internal APIs")}) +@Tags({@Tag(name = "SDCE-2 APIs")}) @Servers({@Server(url = "/sdc2/rest")}) @Controller public class UserAdminServlet extends BeGenericServlet { diff --git a/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml b/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml new file mode 100644 index 0000000000..d4bc0a640d --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-2-sdce-5.yaml @@ -0,0 +1,21 @@ +resourcePackages: +- org.openecomp.sdc.be.servlets +ignoredRoutes: +- /v1/catalog/{componentCollection}/{componentId}/lifecycleState/{lifecycleOperation} +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-2 and SDCE-5" + description: "SDC API for designing services and resources (SDCE-2) and distributing services (SDCE-5)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-2 and SDCE-5 APIs" \ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-4.yaml b/catalog-be/src/main/resources/swagger-config/sdce-4.yaml new file mode 100644 index 0000000000..706d047e69 --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-4.yaml @@ -0,0 +1,19 @@ +resourceClasses: +- org.openecomp.sdc.be.servlets.LifecycleServlet +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-4" + description: "SDC API for certifying services (SDCE-4)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-4 APIs" \ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-6.yaml b/catalog-be/src/main/resources/swagger-config/sdce-6.yaml new file mode 100644 index 0000000000..442ba1766b --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-6.yaml @@ -0,0 +1,19 @@ +resourceClasses: +- org.openecomp.sdc.be.distribution.servlet.DistributionServlet +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-6" + description: "SDC API for distribution subscription (SDCE-6)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-6 APIs" \ No newline at end of file diff --git a/catalog-be/src/main/resources/swagger-config/sdce-7.yaml b/catalog-be/src/main/resources/swagger-config/sdce-7.yaml new file mode 100644 index 0000000000..074ca54731 --- /dev/null +++ b/catalog-be/src/main/resources/swagger-config/sdce-7.yaml @@ -0,0 +1,25 @@ +resourcePackages: +- org.openecomp.sdc.be.externalapi.servlet +- org.openecomp.sdc.be.distribution.servlet +ignoredRoutes: +- /v1/distributionUebCluster +- /v1/registerForDistribution +- /v1/artifactTypes +- /v1/unRegisterForDistribution +prettyPrint: true +sortOutput: true +openAPI: + info: + title: "SPC API: SDCE-7" + description: "SDC API for retrieval for service models (SDCE-7)" + contact: + name: ONAP + url: https://onap.readthedocs.io + email: onap-discuss@lists.onap.org + license: + name: Apache 2.0 + url: http://www.apache.org/licenses/LICENSE-2.0 + version: "1.0" + servers: + - url: /sdc + description: "SDCE-7 APIs" \ No newline at end of file -- cgit 1.2.3-korg