openecomp-be/api/openecomp-sdc-rest-webapp/vendor-software-products-rest/vendor-software-products-rest-services/src/main/java/org/openecomp/sdcrests/vsp/rest/DeploymentFlavors.java

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2019 AT&T Intellectual Property. All rights reserved.
   6  * ================================================================================
   7  * Licensed under the Apache License, Version 2.0 (the "License");
   8  * you may not use this file except in compliance with the License.
   9  * You may obtain a copy of the License at
  10  *
  11  *      http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing, software
  14  * distributed under the License is distributed on an "AS IS" BASIS,
  15  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  16  * See the License for the specific language governing permissions and
  17  * limitations under the License.
  18  * ============LICENSE_END=========================================================
  19  */
  20
  21 package org.openecomp.sdcrests.vsp.rest;
  22
  23 import io.swagger.v3.oas.annotations.Operation;
  24 import io.swagger.v3.oas.annotations.Parameter;
  25 import io.swagger.v3.oas.annotations.info.Info;
  26 import io.swagger.v3.oas.annotations.media.ArraySchema;
  27 import io.swagger.v3.oas.annotations.media.Content;
  28 import io.swagger.v3.oas.annotations.media.Schema;
  29 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  30 import io.swagger.v3.oas.annotations.tags.Tag;
  31 import io.swagger.v3.oas.annotations.tags.Tags;
  32 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorDto;
  33 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorListResponseDto;
  34 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorRequestDto;
  35 import org.springframework.validation.annotation.Validated;
  36
  37 import javax.validation.Valid;
  38 import javax.validation.constraints.NotNull;
  39 import javax.ws.rs.*;
  40 import javax.ws.rs.core.MediaType;
  41 import javax.ws.rs.core.Response;
  42
  43 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  44 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  45
  46
  47 @Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors")
  48 @Produces(MediaType.APPLICATION_JSON)
  49 @Consumes(MediaType.APPLICATION_JSON)
  50 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Vendor Software Product deployment-flavors")})
  51 @Validated
  52 public interface DeploymentFlavors extends VspEntities {
  53
  54   @POST
  55   @Path("/")
  56   @Operation(description = "Create a vendor software product Deployment Flavor")
  57   Response create(@Valid DeploymentFlavorRequestDto request,
  58                   @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  59                   @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  60                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  61                       String user);
  62
  63   @GET
  64   @Path("/")
  65   @Operation(description = "List vendor software product Deployment Flavor", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = DeploymentFlavorListResponseDto.class)))))
  66   Response list(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  67                 @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  68                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  69                     String user);
  70
  71   @GET
  72   @Path("/{deploymentFlavorId}")
  73   @Operation(description = "Get vendor software product Deployment Flavor",responses = @ApiResponse(content = @Content(schema = @Schema(implementation = DeploymentFlavorDto.class))))
  74   Response get(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  75                @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  76                @Parameter(description = "Vendor software product Deployment Flavor Id") @PathParam
  77                    ("deploymentFlavorId") String deploymentFlavorId,
  78                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  79                    String user);
  80
  81   @GET
  82   @Path("/schema")
  83   Response getSchema(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String
  84                         vspId,
  85                      @PathParam("versionId") String versionId,
  86                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  87                    String user);
  88
  89   @DELETE
  90   @Path("/{deploymentFlavorId}")
  91   @Operation(description = "Delete vendor software product Deployment Flavor")
  92   Response delete(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  93                   @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  94                   @Parameter(description = "Vendor software product Deployment Flavor Id")
  95                   @PathParam("deploymentFlavorId") String deploymentFlavorId,
  96                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  97                           String user);
  98
  99   @PUT
 100   @Path("/{deploymentFlavorId}")
 101   @Operation(description = "Update vendor software product Deployment Flavor")
 102   Response update(@Valid DeploymentFlavorRequestDto request,
 103                   @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
 104                   @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
 105                   @Parameter(description = "Vendor software product Deployment Flavor Id")
 106                   @PathParam("deploymentFlavorId") String deploymentFlavorId,
 107                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
 108                       String user);
 109 }