Code Review / sdc.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
Update onboarding upload status during processing
[sdc.git] / openecomp-be / api / openecomp-sdc-rest-webapp / vendor-software-products-rest / vendor-software-products-rest-services / src / main / java / org / openecomp / sdcrests / vsp / rest / Compute.java
diff --git a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/Compute.java b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/Compute.java
index 13d9a04..666fad5 100644 (file)
--- a/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/Compute.java
+++ b/openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/Compute.java
@@ -1,21 +1,37 @@
+/*-
+ * ============LICENSE_START=======================================================
+ * SDC
+ * ================================================================================
+ * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
+ * ================================================================================
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ * ============LICENSE_END=========================================================
+ */
 package org.openecomp.sdcrests.vsp.rest;
 
 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
 
-import io.swagger.annotations.Api;
-import io.swagger.annotations.ApiOperation;
-import io.swagger.annotations.ApiParam;
-import org.openecomp.sdc.versioning.dao.types.Version;
-import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComputeDetailsDto;
-import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComputeDto;
-import org.openecomp.sdcrests.vendorsoftwareproducts.types.QuestionnaireResponseDto;
-import org.openecomp.sdcrests.vendorsoftwareproducts.types.validation.IsValidJson;
-import org.springframework.validation.annotation.Validated;
-
+import io.swagger.v3.oas.annotations.Operation;
+import io.swagger.v3.oas.annotations.Parameter;
+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 javax.validation.Valid;
 import javax.validation.constraints.NotNull;
-import javax.validation.constraints.Pattern;
 import javax.ws.rs.Consumes;
 import javax.ws.rs.DELETE;
 import javax.ws.rs.GET;
@@ -25,107 +41,80 @@ import javax.ws.rs.PUT;
 import javax.ws.rs.Path;
 import javax.ws.rs.PathParam;
 import javax.ws.rs.Produces;
-import javax.ws.rs.QueryParam;
 import javax.ws.rs.core.MediaType;
 import javax.ws.rs.core.Response;
+import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComputeDetailsDto;
+import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComputeDto;
+import org.openecomp.sdcrests.vendorsoftwareproducts.types.QuestionnaireResponseDto;
+import org.openecomp.sdcrests.vendorsoftwareproducts.types.validation.IsValidJson;
+import org.springframework.validation.annotation.Validated;
 
-@Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId" +
-    "}/compute-flavors")
+@Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/components/{componentId" + "}/compute-flavors")
 @Produces(MediaType.APPLICATION_JSON)
 @Consumes(MediaType.APPLICATION_JSON)
-@Api(value = "Vendor Software Product Component Compute-flavors")
+@Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Vendor Software Product Component Compute-flavors")})
 @Validated
 public interface Compute extends VspEntities {
 
-  @GET
-  @Path("/")
-  @ApiOperation(value = "Get list of vendor software product component compute-flavors",
-      response = ComputeDto.class,
-      responseContainer = "List")
-  Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-                @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-                @ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
-                    String componentId,
-                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                    String user);
+    @GET
+    @Path("/")
+    @Operation(description = "Get list of vendor software product component compute-flavors", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = ComputeDto.class)))))
+    Response list(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                  @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                  @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                  @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @GET
-  @Path("/{computeFlavorId}")
-  @ApiOperation(value = "Get vendor software product component compute-flavor",
-      response = ComputeDetailsDto.class,
-      responseContainer = "CompositionEntityResponse")
-  Response get(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-               @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-               @ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
-                   String componentId,
-               @ApiParam(value = "Vendor software product compute-flavor Id") @PathParam
-                   ("computeFlavorId")
-                   String computeId,
-               @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                   String user);
+    @GET
+    @Path("/{computeFlavorId}")
+    @Operation(description = "Get vendor software product component compute-flavor", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = ComputeDetailsDto.class)))))
+    Response get(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                 @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                 @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                 @Parameter(description = "Vendor software product compute-flavor Id") @PathParam("computeFlavorId") String computeId,
+                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @POST
-  @Path("/")
-  @ApiOperation(value = "Create a vendor software product component compute-flavor")
-  Response create(@Valid ComputeDetailsDto request,
-                  @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-                  @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-                  @ApiParam(value = "Vendor software product component Id")
-                  @PathParam("componentId") String componentId,
-                  @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                      String user);
+    @POST
+    @Path("/")
+    @Operation(description = "Create a vendor software product component compute-flavor")
+    Response create(@Valid ComputeDetailsDto request, @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                    @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                    @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                    @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @PUT
-  @Path("/{computeFlavorId}")
-  @ApiOperation(value = "Update vendor software product component compute-flavor")
-  Response update(@Valid ComputeDetailsDto request,
-                  @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-                  @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-                  @ApiParam(value = "Vendor software product component Id")
-                  @PathParam("componentId") String componentId,
-                  @ApiParam(value = "Vendor software product compute-flavor Id") @PathParam
-                      ("computeFlavorId")
-                      String computeFlavorId,
-                  @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                      String user);
+    @PUT
+    @Path("/{computeFlavorId}")
+    @Operation(description = "Update vendor software product component compute-flavor")
+    Response update(@Valid ComputeDetailsDto request, @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                    @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                    @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                    @Parameter(description = "Vendor software product compute-flavor Id") @PathParam("computeFlavorId") String computeFlavorId,
+                    @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @PUT
-  @Path("/{computeFlavorId}/questionnaire")
-  @ApiOperation(value = "Update vendor software product component compute-flavor questionnaire")
-  Response updateQuestionnaire(@NotNull @IsValidJson String questionnaireData,
-                  @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-                  @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-                  @ApiParam(value = "Vendor software product component Id")
-                  @PathParam("componentId") String componentId,
-                  @ApiParam(value = "Vendor software product compute-flavor Id") @PathParam
-                      ("computeFlavorId")
-                      String computeFlavorId,
-                  @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                      String user);
+    @PUT
+    @Path("/{computeFlavorId}/questionnaire")
+    @Operation(description = "Update vendor software product component compute-flavor questionnaire")
+    Response updateQuestionnaire(@NotNull @IsValidJson String questionnaireData,
+                                 @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                                 @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                                 @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                                 @Parameter(description = "Vendor software product compute-flavor Id") @PathParam("computeFlavorId") String computeFlavorId,
+                                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @DELETE
-  @Path("/{computeFlavorId}")
-  @ApiOperation(value = "Delete vendor software product component compute-flavor")
-  Response delete(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-                  @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-                  @ApiParam(value = "Vendor software product component Id")
-                  @PathParam("componentId") String componentId,
-                  @ApiParam(value = "Vendor software product compute-flavor Id") @PathParam
-                      ("computeFlavorId")
-                      String computeFlavorId,
-                  @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
-                      String user);
+    @DELETE
+    @Path("/{computeFlavorId}")
+    @Operation(description = "Delete vendor software product component compute-flavor")
+    Response delete(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                    @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                    @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                    @Parameter(description = "Vendor software product compute-flavor Id") @PathParam("computeFlavorId") String computeFlavorId,
+                    @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 
-  @GET
-  @Path("/{computeFlavorId}/questionnaire")
-  @ApiOperation(value = "Get vendor software product component compute-flavor questionnaire",
-      response = QuestionnaireResponseDto.class)
-  Response getQuestionnaire(
-      @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
-      @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
-      @ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
-          String componentId,
-      @ApiParam(value = "Vendor software product compute-flavor Id") @PathParam
-          ("computeFlavorId") String computeId,
-      @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
+    @GET
+    @Path("/{computeFlavorId}/questionnaire")
+    @Operation(description = "Get vendor software product component compute-flavor questionnaire", responses = @ApiResponse(content = @Content(schema = @Schema(implementation = QuestionnaireResponseDto.class))))
+    Response getQuestionnaire(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
+                              @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
+                              @Parameter(description = "Vendor software product component Id") @PathParam("componentId") String componentId,
+                              @Parameter(description = "Vendor software product compute-flavor Id") @PathParam("computeFlavorId") String computeId,
+                              @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
 }
SDC Parent Project Catalog FE and BE