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