gerrit.onap Code Review - sdc.git/blob

   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.annotations.Api;
  24 import io.swagger.annotations.ApiOperation;
  25 import io.swagger.annotations.ApiParam;
  26 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorDto;
  27 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorListResponseDto;
  28 import org.openecomp.sdcrests.vendorsoftwareproducts.types.DeploymentFlavorRequestDto;
  29 import org.springframework.validation.annotation.Validated;
  30
  31 import javax.validation.Valid;
  32 import javax.validation.constraints.NotNull;
  33 import javax.ws.rs.*;
  34 import javax.ws.rs.core.MediaType;
  35 import javax.ws.rs.core.Response;
  36
  37 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  38 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  39
  40
  41 @Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/deployment-flavors")
  42 @Produces(MediaType.APPLICATION_JSON)
  43 @Consumes(MediaType.APPLICATION_JSON)
  44 @Api(value = "Vendor Software Product deployment-flavors")
  45 @Validated
  46 public interface DeploymentFlavors extends VspEntities {
  47
  48   @POST
  49   @Path("/")
  50   @ApiOperation(value = "Create a vendor software product Deployment Flavor")
  51   Response create(@Valid DeploymentFlavorRequestDto request,
  52                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  53                   @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
  54                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  55                       String user);
  56
  57   @GET
  58   @Path("/")
  59   @ApiOperation(value = "List vendor software product Deployment Flavor",
  60       response = DeploymentFlavorListResponseDto.class,
  61       responseContainer = "List")
  62   Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  63                 @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
  64                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  65                     String user);
  66
  67   @GET
  68   @Path("/{deploymentFlavorId}")
  69   @ApiOperation(value = "Get vendor software product Deployment Flavor",
  70       response = DeploymentFlavorDto.class)
  71   Response get(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  72                @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
  73                @ApiParam(value = "Vendor software product Deployment Flavor Id") @PathParam
  74                    ("deploymentFlavorId") String deploymentFlavorId,
  75                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  76                    String user);
  77
  78   @GET
  79   @Path("/schema")
  80   Response getSchema(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String
  81                         vspId,
  82                      @PathParam("versionId") String versionId,
  83                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  84                    String user);
  85
  86   @DELETE
  87   @Path("/{deploymentFlavorId}")
  88   @ApiOperation(value = "Delete vendor software product Deployment Flavor")
  89   Response delete(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
  90                   @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
  91                   @ApiParam(value = "Vendor software product Deployment Flavor Id")
  92                   @PathParam("deploymentFlavorId") String deploymentFlavorId,
  93                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  94                           String user);
  95
  96   @PUT
  97   @Path("/{deploymentFlavorId}")
  98   @ApiOperation(value = "Update vendor software product Deployment Flavor")
  99   Response update(@Valid DeploymentFlavorRequestDto request,
 100                   @ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
 101                   @ApiParam(value = "Version Id") @PathParam("versionId") String versionId,
 102                   @ApiParam(value = "Vendor software product Deployment Flavor Id")
 103                   @PathParam("deploymentFlavorId") String deploymentFlavorId,
 104                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
 105                       String user);
 106 }