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

   1 /*-
   2  * ============LICENSE_START=======================================================
   3  * SDC
   4  * ================================================================================
   5  * Copyright (C) 2017 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 com.sun.jersey.multipart.FormDataParam;
  24 import io.swagger.v3.oas.annotations.Operation;
  25 import io.swagger.v3.oas.annotations.info.Info;
  26 import io.swagger.v3.oas.annotations.media.Content;
  27 import io.swagger.v3.oas.annotations.media.Schema;
  28 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  29 import io.swagger.v3.oas.annotations.tags.Tag;
  30 import io.swagger.v3.oas.annotations.tags.Tags;
  31 import org.openecomp.sdcrests.vendorsoftwareproducts.types.UploadFileResponseDto;
  32 import org.springframework.validation.annotation.Validated;
  33
  34 import javax.validation.constraints.NotNull;
  35 import javax.ws.rs.*;
  36 import javax.ws.rs.core.MediaType;
  37 import javax.ws.rs.core.Response;
  38 import java.io.InputStream;
  39
  40 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  41 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  42
  43 @Path("/v1.0/vendor-software-products")
  44 @Produces(MediaType.APPLICATION_JSON)
  45 @Consumes(MediaType.APPLICATION_JSON)
  46 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Vendor Software Products")})
  47 @Validated
  48 public interface VendorSoftwareProductsForSwaggerFileUpload {
  49
  50
  51
  52   @POST
  53   @Path("/{vspId}/versions/{versionId}/orchestration-template-candidate")
  54   @Consumes(MediaType.MULTIPART_FORM_DATA)
  55   @Operation(description = "Uploads a HEAT package to translate",responses = @ApiResponse(content = @Content(schema = @Schema(implementation = UploadFileResponseDto.class))))
  56   Response uploadOrchestrationTemplateCandidate(@PathParam("vspId") String vspId,
  57                                                 @PathParam("versionId") String versionId,
  58                                                 @FormDataParam("upload")
  59                                                     InputStream heatFileToUpload,
  60                                                 @NotNull(message = USER_MISSING_ERROR_MSG)
  61                                                 @HeaderParam(USER_ID_HEADER_PARAM) String user);
  62
  63  }