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.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.ComponentDependencyModel;
  33 import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComponentDependencyResponseDto;
  34 import org.springframework.validation.annotation.Validated;
  35
  36 import javax.validation.Valid;
  37 import javax.validation.constraints.NotNull;
  38 import javax.ws.rs.*;
  39 import javax.ws.rs.core.MediaType;
  40 import javax.ws.rs.core.Response;
  41
  42 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  43 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  44
  45 @Path("/v1.0/vendor-software-products/{vspId}/versions/{versionId}/component-dependencies")
  46 @Produces(MediaType.APPLICATION_JSON)
  47 @Consumes(MediaType.APPLICATION_JSON)
  48 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Vendor Software Product Component Dependencies")})
  49 @Validated
  50 public interface ComponentDependencies extends VspEntities {
  51
  52   @POST
  53   @Path("/")
  54   @Operation( description= "Create a vendor software product component dependency")
  55   Response create(@Valid ComponentDependencyModel request,
  56                   @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  57                   @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  58                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  59                       String user);
  60
  61   @GET
  62   @Path("/")
  63   @Operation(description = "Get component dependencies for vendor software product", responses = @ApiResponse(content = @Content(array = @ArraySchema( schema = @Schema(implementation = ComponentDependencyResponseDto.class)))))
  64   Response list(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  65                 @Parameter(description = "Vendor software product version Id") @PathParam("versionId")
  66                     String versionId,
  67                 @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  68                     String user);
  69
  70   @DELETE
  71   @Path("/{dependencyId}")
  72   @Operation(description = "Delete component dependency for vendor software product")
  73   Response delete(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  74                   @Parameter(description = "Vendor software product version Id")
  75                   @PathParam("versionId") String versionId,
  76                   @Parameter(description = "Vendor software product Component Dependency Id") @PathParam
  77                       ("dependencyId") String dependencyId,
  78                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  79                       String user);
  80
  81   @PUT
  82   @Path("/{dependencyId}")
  83   @Operation(description = "Update component dependency for vendor software product")
  84   Response update(@Valid ComponentDependencyModel request,
  85                   @Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  86                   @Parameter(description = "Vendor software product version Id") @PathParam("versionId")
  87                       String versionId,
  88                   @Parameter(description = "Vendor software product Component Dependency Id") @PathParam
  89                       ("dependencyId") String dependencyId,
  90                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
  91                       String user);
  92
  93   @GET
  94   @Path("/{dependencyId}")
  95   @Operation(description = "Get component dependency for vendor software product", responses = @ApiResponse(content = @Content(schema = @Schema(implementation =ComponentDependencyResponseDto.class))))
  96   Response get(@Parameter(description = "Vendor software product Id") @PathParam("vspId") String vspId,
  97                @Parameter(description = "Version Id") @PathParam("versionId") String versionId,
  98                @Parameter(description = "Vendor software product Component Dependency Id") @PathParam
  99                    ("dependencyId") String dependencyId,
 100                @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM)
 101                    String user);
 102 }