2 * Copyright © 2018 European Support Limited
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
8 * http://www.apache.org/licenses/LICENSE-2.0
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.
16 package org.openecomp.sdcrests.item.rest;
18 import io.swagger.v3.oas.annotations.Operation;
19 import io.swagger.v3.oas.annotations.Parameter;
20 import io.swagger.v3.oas.annotations.info.Info;
21 import io.swagger.v3.oas.annotations.media.ArraySchema;
22 import io.swagger.v3.oas.annotations.media.Content;
23 import io.swagger.v3.oas.annotations.media.Schema;
24 import io.swagger.v3.oas.annotations.responses.ApiResponse;
25 import io.swagger.v3.oas.annotations.tags.Tag;
26 import io.swagger.v3.oas.annotations.tags.Tags;
27 import org.openecomp.sdc.versioning.types.Item;
28 import org.openecomp.sdcrests.item.types.ItemActionRequestDto;
29 import org.springframework.validation.annotation.Validated;
31 import javax.validation.constraints.NotNull;
33 import javax.ws.rs.core.MediaType;
34 import javax.ws.rs.core.Response;
37 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
38 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
41 @Produces(MediaType.APPLICATION_JSON)
42 @Consumes(MediaType.APPLICATION_JSON)
43 @Tags({@Tag(name = "SDCE-1 APIs"), @Tag(name = "Items")})
45 public interface Items {
49 @Operation(description = "Get list of items according to desired filters", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Item.class)))))
50 Response list(@Parameter(description = "Filter by item status", schema = @Schema(type = "string", allowableValues = {"ACTIVE", "ARCHIVED"}))
51 @QueryParam("itemStatus") String itemStatusFilter,
52 @Parameter(description = "Filter by version status", schema = @Schema(type = "string", allowableValues = {"Certified", "Draft"}))
53 @QueryParam("versionStatus") String versionStatusFilter,
54 @Parameter(description = "Filter by item type", schema = @Schema(type = "string", allowableValues = {"vsp", "vlm"}))
55 @QueryParam("itemType") String itemTypeFilter,
56 @Parameter(description = "Filter by user permission", schema = @Schema(type = "string", allowableValues = {"Owner", "Contributor"}))
57 @QueryParam("permission") String permissionFilter,
58 @Parameter(description = "Filter by onboarding method", schema = @Schema(type = "string", allowableValues = {"NetworkPackage", "manual"}))
59 @QueryParam("onboardingMethod") String onboardingMethodFilter,
60 @NotNull(message = USER_MISSING_ERROR_MSG)
61 @HeaderParam(USER_ID_HEADER_PARAM) String user);
65 @Operation(description = "Get details of a item")
66 Response getItem(@PathParam("itemId") String itemId,
67 @NotNull(message = USER_MISSING_ERROR_MSG)
68 @HeaderParam(USER_ID_HEADER_PARAM) String user);
71 @Path("/{itemId}/actions")
72 @Operation(description = "Acts on item version")
73 Response actOn(ItemActionRequestDto request,
74 @PathParam("itemId") String itemId,
75 @NotNull(message = USER_MISSING_ERROR_MSG)
76 @HeaderParam(USER_ID_HEADER_PARAM) String user);