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