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
|
/*
* Copyright © 2017-2019 AT&T Intellectual Property.
* Modifications Copyright © 2018 IBM.
*
* 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.
*
*
* Unless otherwise specified, all documentation contained herein is licensed
* under the Creative Commons License, Attribution 4.0 Intl. (the "License");
* you may not use this documentation except in compliance with the License.
* You may obtain a copy of the License at
*
* https://creativecommons.org/licenses/by/4.0/
*
* Unless required by applicable law or agreed to in writing, documentation
* 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.onap.optf.ticketmgt.service.rs;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import io.swagger.annotations.ApiResponse;
import io.swagger.annotations.ApiResponses;
import javax.ws.rs.DELETE;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;
import org.onap.optf.cmso.common.CMSRequestError;
import org.onap.optf.ticketmgt.service.rs.models.ActiveTicketsRequest;
import org.onap.optf.ticketmgt.service.rs.models.ActiveTicketsResponse;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
@Api("Availability Interface")
@Path("/{apiVersion}")
@Produces({MediaType.APPLICATION_JSON})
public interface AvailabilityInterface {
// ******************************************************************
@POST
@Path("/activetickets")
@Produces({MediaType.APPLICATION_JSON})
@RequestMapping(value = "/{apiVersion}/activetickets", method = RequestMethod.POST,
consumes = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON)
@ApiOperation(value = "Request Active Tickets",
notes = "API to support conflict avoidance. Retrieves the active ticket data for the "
+ "passed criteria to detemine availability of passed elements"
+ " within the passed time window."
+ "\nIf the request results in asynchronous processging, IN_PROGRESS"
+ " status will be returned and the "
+ "optimizer will begin to poll the request until COMPLETED.",
response = ActiveTicketsResponse.class)
@ApiResponses(value = {@ApiResponse(code = 200, message = "OK"),
@ApiResponse(code = 400, message = "Bad request", response = CMSRequestError.class),
@ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
public Response getActiveTickets(
@ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
value = "v1") @DefaultValue("v1") String apiVersion,
@ApiParam(value = "Active ticket criteria (elements and change windows).")
ActiveTicketsRequest activeTicketsRequest);
@GET
@Path("/activetickets/{id}")
@Produces({MediaType.APPLICATION_JSON})
@RequestMapping(value = "/{apiVersion}/activetickets/{id}", method = RequestMethod.GET,
consumes = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON)
@ApiOperation(value = "Poll Active Tickets Request",
notes = "Poll for the status of the request id. Optimizser will "
+ " poll until status is COMPLETED and issue acknowledge"
+ " (DELETE) API to acknowledge the "
+ "receipt of the response.",
response = ActiveTicketsResponse.class)
@ApiResponses(value = {@ApiResponse(code = 200, message = "OK"),
@ApiResponse(code = 404, message = "Not found.", response = CMSRequestError.class),
@ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
public Response pollActiveTickets(
@ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
value = "v1") @DefaultValue("v1") String apiVersion,
@ApiParam(value = "Active tickets request id.") @PathParam("id") String id);
@DELETE
@Path("/activetickets/{id}")
@Produces({MediaType.APPLICATION_JSON})
@RequestMapping(value = "/{apiVersion}/activetickets/{id}", method = RequestMethod.DELETE,
consumes = MediaType.APPLICATION_JSON, produces = MediaType.APPLICATION_JSON)
@ApiOperation(value = "Acknowledge Active Tickets Response", notes = "API call used to acknowledge the receipt"
+ " of a COMPLETED asynchronous request to enable the Ticket Management service"
+ " to remove it from their cache."
+ " The service may remove from the cache on the poll request. The optimizer will"
+ " treat Not found reponse on as normal.",
response = ActiveTicketsResponse.class)
@ApiResponses(value = {@ApiResponse(code = 204, message = "OK"),
@ApiResponse(code = 404, message = "Not found", response = CMSRequestError.class),
@ApiResponse(code = 500, message = "Unexpected Runtime error", response = Exception.class)})
public Response deleteActiveTicketsRequest(
@ApiParam(value = "v1") @PathParam("apiVersion") @PathVariable(
value = "v1") @DefaultValue("v1") String apiVersion,
@ApiParam(value = "Active tickets request id.") @PathParam("id") String id);
}
|
