aboutsummaryrefslogtreecommitdiffstats
path: root/cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java
diff options
context:
space:
mode:
Diffstat (limited to 'cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java')
-rw-r--r--cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java32
1 files changed, 19 insertions, 13 deletions
diff --git a/cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java b/cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java
index cf9c269..3360927 100644
--- a/cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java
+++ b/cmso-ticketmgt/src/main/java/org/onap/optf/ticketmgt/service/rs/AvailabilityInterface.java
@@ -1,27 +1,27 @@
/*
* 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.
@@ -65,8 +65,10 @@ public interface AvailabilityInterface {
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 "
+ + "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"),
@@ -75,7 +77,8 @@ public interface AvailabilityInterface {
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);
+ @ApiParam(value = "Active ticket criteria (elements and change windows).")
+ ActiveTicketsRequest activeTicketsRequest);
@GET
@Path("/activetickets/{id}")
@@ -84,7 +87,8 @@ public interface AvailabilityInterface {
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 "
+ + " 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"),
@@ -101,8 +105,10 @@ public interface AvailabilityInterface {
@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.",
+ + " 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),