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
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
|
/*-
* ============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.action.rest;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import org.apache.cxf.jaxrs.ext.multipart.Attachment;
import org.apache.cxf.jaxrs.ext.multipart.Multipart;
import org.openecomp.sdcrests.action.types.ActionResponseDto;
import org.springframework.validation.annotation.Validated;
import javax.servlet.http.HttpServletRequest;
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.Context;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
/**
* Defines various CRUD API that can be performed on Action.
*/
@Path("/workflow/v1.0/actions")
@Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON)
@Api(value = "Actions")
@Validated
public interface Actions {
/**
* List All Major, Last Minor and Candidate version if any for Given Action Invariant UuId
*
* @return List of All Major, Last Minor and Candidate version if any Of Action with given
actionInvariantUuId. If actionUuId is provided then only action with given actionInvariantUuId
and actionUuId
*/
@GET
@Path("/{actionInvariantUuId}")
@ApiOperation(value = "List Actions For Given Action Invariant UuId", responseContainer = "List")
Response getActionsByActionInvariantUuId(
@PathParam("actionInvariantUuId") String actionInvariantUuId,
@QueryParam("version") String actionUuId, @Context HttpServletRequest servletRequest);
/**
* Get list of actions based on a filter criteria. If no filter is sent all actions will be
* returned
*
* @return List Of Last Major and Last Minor of All Actions based on filter criteria
*/
@GET
@ApiOperation(value = "List Filtered Actions ",
notes = "Get list of actions based on a filter criteria | If no filter is sent all actions "
+ "will be returned",
responseContainer = "List")
Response getFilteredActions(@QueryParam("vendor") String vendor,
@QueryParam("category") String category,
@QueryParam("name") String name,
@QueryParam("modelId") String modelId,
@QueryParam("componentId") String componentId,
@Context HttpServletRequest servletRequest);
/**
* List OPENECOMP Components supported by Action Library.
*
* @return List of OPENECOMP Components supported by Action Library
*/
@GET
@Path("/components")
@ApiOperation(value = "List OPENECOMP Components supported by Action Library",
responseContainer = "List")
Response getOpenEcompComponents(@Context HttpServletRequest servletRequest);
/**
* Create a new Action based on request JSON.
*
* @return Metadata object {@link ActionResponseDto ActionResponseDto} object for created Action
*/
@POST
@ApiOperation(value = "Create a new Action")
Response createAction(String requestJson, @Context HttpServletRequest servletRequest);
/**
* Update an existing action with parameters provided in requestJson.
*
* @return Metadata object {@link ActionResponseDto ActionResponseDto} object for created Action
*/
@PUT
@Path("/{actionInvariantUuId}")
@ApiOperation(value = "Update an existing action")
Response updateAction(@PathParam("actionInvariantUuId") String actionInvariantUuId,
String requestJson, @Context HttpServletRequest servletRequest);
/**
* Delete an action.
*
* @param actionInvariantUuId Invariant UuId of the action to be deleted
* @param servletRequest Servlet request object
* @return Empty response object
*/
@DELETE
@Path("/{actionInvariantUuId}")
@ApiOperation(value = "Delete Action")
Response deleteAction(@PathParam("actionInvariantUuId") String actionInvariantUuId,
@Context HttpServletRequest servletRequest);
/**
* Performs Checkout/Undo_Checkout/Checkin/Submit Operation on Action.
*
* @return Metadata object {@link ActionResponseDto ActionResponseDto} object for created Action
*/
@POST
@Path("/{actionInvariantUuId}")
@ApiOperation(value = "Actions on a action",
notes = "Performs one of the following actions on a action: |"
+ "Checkout: Locks it for edits by other users. Only the locking user sees the edited "
+ "version.|"
+ "Undo_Checkout: Unlocks it and deletes the edits that were done.|"
+ "Checkin: Unlocks it and activates the edited version to all users.| "
+ "Submit: Finalize its active version.|")
Response actOnAction(@PathParam("actionInvariantUuId") String actionInvariantUuId,
String requestJson, @Context HttpServletRequest servletRequest);
/**
* Upload an artifact to an action.
*
* @param actionInvariantUuId Invariant UuId of the action to which the artifact is uploaded
* @param artifactName Name of the artifact
* @param artifactLabel Label of the artifact
* @param artifactCategory Category of the artifact
* @param artifactDescription Description of the artifact
* @param artifactProtection Artifact protection mode
* @param checksum Checksum of the artifact
* @param artifactToUpload Artifact content object
* @param servletRequest Servlet request object
* @return Generated UuId of the uploaded artifact
*/
@POST
@Path("/{actionInvariantUuId}/artifacts")
@Consumes(MediaType.MULTIPART_FORM_DATA)
Response uploadArtifact(@PathParam("actionInvariantUuId") String actionInvariantUuId,
@Multipart(value = "artifactName", required = false) String artifactName,
@Multipart(value = "artifactLabel", required = false) String artifactLabel,
@Multipart(value = "artifactCategory", required = false) String artifactCategory,
@Multipart(value = "artifactDescription", required = false) String artifactDescription,
@Multipart(value = "artifactProtection", required = false) String artifactProtection,
@HeaderParam("Content-MD5") String checksum,
@Multipart(value = "uploadArtifact", required = false) Attachment artifactToUpload,
@Context HttpServletRequest servletRequest);
@GET
@Path("/{actionUuId}/artifacts/{artifactUuId}")
@Produces(MediaType.APPLICATION_OCTET_STREAM)
@ApiOperation(value = "Downloads artifact for action")
Response downloadArtifact(@PathParam("actionUuId") String actionUuId,
@PathParam("artifactUuId") String artifactUuId,
@Context HttpServletRequest servletRequest);
@DELETE
@Path("/{actionInvariantUuId}/artifacts/{artifactUuId}")
@ApiOperation(value = "Delete Artifact")
Response deleteArtifact(@PathParam("actionInvariantUuId") String actionInvariantUuId,
@PathParam("artifactUuId") String artifactUuId,
@Context HttpServletRequest servletRequest);
@PUT
@Path("/{actionInvariantUuId}/artifacts/{artifactUuId}")
@Consumes(MediaType.MULTIPART_FORM_DATA)
Response updateArtifact(@PathParam("actionInvariantUuId") String actionInvariantUuId,
@PathParam("artifactUuId") String artifactUuId,
@Multipart(value = "artifactName", required = false) String artifactName,
@Multipart(value = "artifactLabel", required = false) String artifactLabel,
@Multipart(value = "artifactCategory", required = false) String artifactCategory,
@Multipart(value = "artifactDescription", required = false) String artifactDescription,
@Multipart(value = "artifactProtection", required = false) String artifactProtection,
@HeaderParam("Content-MD5") String checksum,
@Multipart(value = "updateArtifact", required = false) Attachment artifactToUpdate,
@Context HttpServletRequest servletRequest);
}
|
