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.OpenAPIDefinition;
19 import io.swagger.v3.oas.annotations.Operation;
20 import io.swagger.v3.oas.annotations.Parameter;
21 import io.swagger.v3.oas.annotations.info.Info;
22 import io.swagger.v3.oas.annotations.media.ArraySchema;
23 import io.swagger.v3.oas.annotations.media.Content;
24 import io.swagger.v3.oas.annotations.media.Schema;
25 import io.swagger.v3.oas.annotations.responses.ApiResponse;
26 import org.openecomp.sdc.versioning.types.Item;
27 import org.openecomp.sdcrests.item.types.ItemActionRequestDto;
28 import org.springframework.validation.annotation.Validated;
30 import javax.validation.constraints.NotNull;
32 import javax.ws.rs.core.MediaType;
33 import javax.ws.rs.core.Response;
36 import static org.openecomp.sdcrests.common.RestConstants.USER_ID_HEADER_PARAM;
37 import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
40 @Produces(MediaType.APPLICATION_JSON)
41 @Consumes(MediaType.APPLICATION_JSON)
42 @OpenAPIDefinition(info = @Info(title = "Items"))
44 public interface Items {
48 @Operation(description = "Get list of items according to desired filters", responses = @ApiResponse(content = @Content(array = @ArraySchema(schema = @Schema(implementation = Item.class)))))
49 Response list(@Parameter(description = "Filter by item status", schema = @Schema(type = "string", allowableValues = {"ACTIVE", "ARCHIVED"}))
50 @QueryParam("itemStatus") String itemStatusFilter,
51 @Parameter(description = "Filter by version status", schema = @Schema(type = "string", allowableValues = {"Certified", "Draft"}))
52 @QueryParam("versionStatus") String versionStatusFilter,
53 @Parameter(description = "Filter by item type", schema = @Schema(type = "string", allowableValues = {"vsp", "vlm"}))
54 @QueryParam("itemType") String itemTypeFilter,
55 @Parameter(description = "Filter by user permission", schema = @Schema(type = "string", allowableValues = {"Owner", "Contributor"}))
56 @QueryParam("permission") String permissionFilter,
57 @Parameter(description = "Filter by onboarding method", schema = @Schema(type = "string", allowableValues = {"NetworkPackage", "manual"}))
58 @QueryParam("onboardingMethod") String onboardingMethodFilter,
59 @NotNull(message = USER_MISSING_ERROR_MSG)
60 @HeaderParam(USER_ID_HEADER_PARAM) String user);
64 @Operation(description = "Get details of a item")
65 Response getItem(@PathParam("itemId") String itemId,
66 @NotNull(message = USER_MISSING_ERROR_MSG)
67 @HeaderParam(USER_ID_HEADER_PARAM) String user);
70 @Path("/{itemId}/actions")
71 @Operation(description = "Acts on item version")
72 Response actOn(ItemActionRequestDto request,
73 @PathParam("itemId") String itemId,
74 @NotNull(message = USER_MISSING_ERROR_MSG)
75 @HeaderParam(USER_ID_HEADER_PARAM) String user);