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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
/*-
* ============LICENSE_START=======================================================
* SDC
* ================================================================================
* Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
* ================================================================================
* 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.
* ============LICENSE_END=========================================================
*/
package org.openecomp.sdcrests.vsp.rest;
import static org.openecomp.sdcrests.common.RestConstants.USER_HEADER_PARAM;
import static org.openecomp.sdcrests.common.RestConstants.USER_MISSING_ERROR_MSG;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.openecomp.sdc.vendorsoftwareproduct.types.composition.ComponentData;
import org.openecomp.sdc.versioning.dao.types.Version;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComponentDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.ComponentRequestDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.QuestionnaireResponseDto;
import org.openecomp.sdcrests.vendorsoftwareproducts.types.validation.IsValidJson;
import org.springframework.validation.annotation.Validated;
import javax.validation.Valid;
import javax.validation.constraints.NotNull;
import javax.validation.constraints.Pattern;
import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.HeaderParam;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
@Path("/v1.0/vendor-software-products/{vspId}/components")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Api(value = "Vendor Software Product Components")
@Validated
public interface Components {
@GET
@Path("/")
@ApiOperation(value = "List vendor software product components",
response = ComponentDto.class,
responseContainer = "List")
Response list(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@Pattern(regexp = Version.VERSION_REGEX,
message = Version.VERSION_STRING_VIOLATION_MSG) @QueryParam("version")
String version,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM)
String user);
@DELETE
@Path("/")
@ApiOperation(value = "Delete vendor software product components",
responseContainer = "List")
Response deleteList(
@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM) String user);
@POST
@Path("/")
@ApiOperation(value = "Create a vendor software product component")
Response create(@Valid ComponentRequestDto request,
@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM)
String user);
@GET
@Path("/{componentId}")
@ApiOperation(value = "Get vendor software product component",
response = ComponentData.class,
responseContainer = "CompositionEntityResponse")
Response get(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
String componentId,
@Pattern(regexp = Version.VERSION_REGEX,
message = Version.VERSION_STRING_VIOLATION_MSG) @QueryParam("version")
String version,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM)
String user);
@DELETE
@Path("/{componentId}")
@ApiOperation(value = "Delete vendor software product component")
Response delete(@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@ApiParam(value = "Vendor software product component Id")
@PathParam("componentId") String componentId,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM)
String user);
@PUT
@Path("/{componentId}")
@ApiOperation(value = "Update vendor software product component")
Response update(@Valid ComponentRequestDto request,
@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@ApiParam(value = "Vendor software product component Id")
@PathParam("componentId") String componentId,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM)
String user);
@GET
@Path("/{componentId}/questionnaire")
@ApiOperation(value = "Get vendor software product component questionnaire",
response = QuestionnaireResponseDto.class)
Response getQuestionnaire(
@ApiParam(value = "Vendor software product Id") @PathParam("vspId") String vspId,
@ApiParam(value = "Vendor software product component Id") @PathParam("componentId")
String componentId,
@Pattern(regexp = Version.VERSION_REGEX, message = Version.VERSION_STRING_VIOLATION_MSG)
@QueryParam("version") String version,
@NotNull(message = USER_MISSING_ERROR_MSG) @HeaderParam(USER_HEADER_PARAM) String user);
@PUT
@Path("/{componentId}/questionnaire")
@ApiOperation(value = "Update vendor software product component questionnaire")
Response updateQuestionnaire(@NotNull @IsValidJson String questionnaireData,
@ApiParam(value = "Vendor software product Id") @PathParam("vspId")
String vspId,
@ApiParam(value = "Vendor software product component Id")
@PathParam("componentId") String componentId,
@NotNull(message = USER_MISSING_ERROR_MSG)
@HeaderParam(USER_HEADER_PARAM) String user);
}
|
