gerrit.onap Code Review - sdc.git/blob

   1 /*
   2  * Copyright © 2018 European Support Limited
   3  *
   4  * Licensed under the Apache License, Version 2.0 (the "License");
   5  * you may not use this file except in compliance with the License.
   6  * You may obtain a copy of the License at
   7  *
   8  *      http://www.apache.org/licenses/LICENSE-2.0
   9  *
  10  * Unless required by applicable law or agreed to in writing, software
  11  * distributed under the License is distributed on an "AS IS" BASIS,
  12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  13  * See the License for the specific language governing permissions and
  14  * limitations under the License.
  15  */
  16 package org.openecomp.sdcrests.item.rest;
  17
  18 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
  19 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
  20
  21 import io.swagger.v3.oas.annotations.Operation;
  22 import io.swagger.v3.oas.annotations.Parameter;
  23 import io.swagger.v3.oas.annotations.media.ArraySchema;
  24 import io.swagger.v3.oas.annotations.media.Content;
  25 import io.swagger.v3.oas.annotations.media.Schema;
  26 import io.swagger.v3.oas.annotations.responses.ApiResponse;
  27 import io.swagger.v3.oas.annotations.tags.Tag;
  28 import io.swagger.v3.oas.annotations.tags.Tags;
  29 import javax.validation.constraints.NotNull;
  30 import javax.ws.rs.Consumes;
  31 import javax.ws.rs.GET;
  32 import javax.ws.rs.HeaderParam;
  33 import javax.ws.rs.PUT;
  34 import javax.ws.rs.Path;
  35 import javax.ws.rs.PathParam;
  36 import javax.ws.rs.Produces;
  37 import javax.ws.rs.QueryParam;
  38 import javax.ws.rs.core.MediaType;
  39 import javax.ws.rs.core.Response;
  40 import org.openecomp.sdc.versioning.types.Item;
  41 import org.openecomp.sdcrests.item.types.ItemActionRequestDto;
  42 import org.springframework.validation.annotation.Validated;
  43
  44 @Path("/v1.0/items")
  45 @Produces(MediaType.APPLICATION_JSON)
  46 @Consumes(MediaType.APPLICATION_JSON)
  47 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Items")})
  48 @Validated
  49 public interface Items {
  50
  51     @GET
  52     @Path("/")
  53     @Operation(description = "Get list of items according to desired filters", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Item.class)))))
  54     Response list(@Parameter(description = "Filter by item status", schema = @Schema(type = "string", allowableValues = {"ACTIVE", "ARCHIVED"}))
  55                   @QueryParam("itemStatus") String itemStatusFilter,
  56                   @Parameter(description = "Filter by version status", schema = @Schema(type = "string", allowableValues = {"Certified", "Draft"}))
  57                   @QueryParam("versionStatus") String versionStatusFilter,
  58                   @Parameter(description = "Filter by item type", schema = @Schema(type = "string", allowableValues = {"vsp", "vlm"}))
  59                   @QueryParam("itemType") String itemTypeFilter,
  60                   @Parameter(description = "Filter by user permission", schema = @Schema(type = "string", allowableValues = {"Owner", "Contributor"}))
  61                   @QueryParam("permission") String permissionFilter,
  62                   @Parameter(description = "Filter by onboarding method", schema = @Schema(type = "string", allowableValues = {"NetworkPackage", "manual"}))
  63                   @QueryParam("onboardingMethod") String onboardingMethodFilter,
  64                   @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  65
  66     @GET
  67     @Path("/{itemId}")
  68     @Operation(description = "Get details of a item")
  69     Response getItem(@PathParam("itemId") String itemId, @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  70
  71     @PUT
  72     @Path("/{itemId}/actions")
  73     @Operation(description = "Acts on item version")
  74     Response actOn(ItemActionRequestDto request, @PathParam("itemId") String itemId,
  75                    @NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_ID_HEADER_PARAM) String user);
  76 }