|
24 | 24 | import java.util.ArrayList;
|
25 | 25 |
|
26 | 26 | @javax.annotation.Generated(value = "io.swagger.codegen.v3.generators.java.SpringCodegen", date = "2020-03-20T16:31:52.030Z[GMT]")
|
27 |
| -@Api(value = "batches", description = "the batches API") |
28 |
| -public interface BatchesApi { |
| 27 | +@Api(value = "batchDeletes", description = "the batch deletes API") |
| 28 | +public interface BatchDeletesApi { |
29 | 29 |
|
30 |
| - @ApiOperation(value = "Get the details of a specific Batch", nickname = "batchesBatchDbIdGet", notes = "Get a specific generic batches", response = BatchesSingleResponse.class, authorizations = { |
31 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
32 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchesSingleResponse.class), |
| 30 | + @ApiOperation(value = "Get the details of a specific Batch Delete", nickname = "batchDeletesBatchDbIdGet", notes = "Get a specific generic batch delete", response = BatchDeletesSingleResponse.class, authorizations = { |
| 31 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 32 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeletesSingleResponse.class), |
33 | 33 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
34 | 34 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
35 | 35 | @ApiResponse(code = 403, message = "Forbidden", response = String.class),
|
36 | 36 | @ApiResponse(code = 404, message = "Not Found", response = String.class) })
|
37 |
| - @RequestMapping(value = "/batches/{batchDbId}", produces = { "application/json" }, method = RequestMethod.GET) |
38 |
| - ResponseEntity<BatchesSingleResponse> batchesBatchDbIdGet( |
39 |
| - @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDbId") String batchDbId, |
| 37 | + @RequestMapping(value = "/batchDeletes/{batchDeleteDbId}", produces = { "application/json" }, method = RequestMethod.GET) |
| 38 | + ResponseEntity<BatchDeletesSingleResponse> batchDeletesBatchDbIdGet( |
| 39 | + @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDeletDbId") String batchDbId, |
40 | 40 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization)
|
41 | 41 | throws BrAPIServerException;
|
42 | 42 |
|
43 |
| - @ApiOperation(value = "Add Items to a specific Batch", nickname = "batchesBatchDbIdItemsPost", notes = "Add new data to a specific generic batches", response = BatchResponse.class, authorizations = { |
44 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
45 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchResponse.class), |
| 43 | + @ApiOperation(value = "Add Items to a specific Batch Delete", nickname = "batchDeletesBatchDbIdItemsPost", notes = "Add new data to a specific generic batch delete", response = BatchDeleteResponse.class, authorizations = { |
| 44 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 45 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeleteResponse.class), |
46 | 46 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
47 | 47 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
48 | 48 | @ApiResponse(code = 403, message = "Forbidden", response = String.class),
|
49 | 49 | @ApiResponse(code = 404, message = "Not Found", response = String.class) })
|
50 |
| - @RequestMapping(value = "/batches/{batchDbId}/items", produces = { "application/json" }, consumes = { |
| 50 | + @RequestMapping(value = "/batchDeletes/{batchDeleteDbId}/items", produces = { "application/json" }, consumes = { |
51 | 51 | "application/json" }, method = RequestMethod.POST)
|
52 |
| - ResponseEntity<BatchResponse> batchesBatchDbIdItemsPost( |
53 |
| - @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDbId") String batchDbId, |
| 52 | + ResponseEntity<BatchDeleteResponse> batchDeletesBatchDbIdItemsPost( |
| 53 | + @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDeleteDbId") String batchDeleteDbId, |
54 | 54 | @ApiParam(value = "") @Valid @RequestBody ArrayList<String> body,
|
55 | 55 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization)
|
56 | 56 | throws BrAPIServerException;
|
57 | 57 |
|
58 |
| - @ApiOperation(value = "Add Items to a specific Batch", nickname = "batchesBatchDbIdDataPost", notes = "Add new data to a specific generic batches", response = BatchResponse.class, authorizations = { |
59 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
60 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchResponse.class), |
| 58 | + @ApiOperation(value = "Add Items to a specific Batch Delete", nickname = "batchDeletesBatchDbIdDataPost", notes = "Add new data to a specific generic batch delete", response = BatchDeleteResponse.class, authorizations = { |
| 59 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 60 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeleteResponse.class), |
61 | 61 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
62 | 62 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
63 | 63 | @ApiResponse(code = 403, message = "Forbidden", response = String.class),
|
64 | 64 | @ApiResponse(code = 404, message = "Not Found", response = String.class) })
|
65 |
| - @RequestMapping(value = "/batches/{batchDbId}/data", produces = { "application/json" }, consumes = { |
| 65 | + @RequestMapping(value = "/batchDeletes/{batchDeleteDbId}/data", produces = { "application/json" }, consumes = { |
66 | 66 | "application/json" }, method = RequestMethod.POST)
|
67 |
| - ResponseEntity<BatchResponse> batchesBatchDbIdDataPost( |
68 |
| - @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDbId") String batchDbId, |
| 67 | + ResponseEntity<BatchDeleteResponse> batchDeletesBatchDbIdDataPost( |
| 68 | + @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDeleteDbId") String batchDbId, |
69 | 69 | @ApiParam(value = "") @Valid @RequestBody ArrayList<String> body,
|
70 | 70 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization)
|
71 | 71 | throws BrAPIServerException;
|
72 | 72 |
|
73 |
| - @ApiOperation(value = "Update an existing generic batch", nickname = "batchesBatchDbIdPut", notes = "Update an existing generic batch", response = BatchesSingleResponse.class, authorizations = { |
74 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
75 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchesSingleResponse.class), |
| 73 | + @ApiOperation(value = "Update an existing generic batch delete", nickname = "batchDeletesBatchDbIdPut", notes = "Update an existing generic batch delete", response = BatchDeletesSingleResponse.class, authorizations = { |
| 74 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 75 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeletesSingleResponse.class), |
76 | 76 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
77 | 77 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
78 | 78 | @ApiResponse(code = 403, message = "Forbidden", response = String.class),
|
79 | 79 | @ApiResponse(code = 404, message = "Not Found", response = String.class) })
|
80 |
| - @RequestMapping(value = "/batches/{batchDbId}", produces = { "application/json" }, consumes = { |
| 80 | + @RequestMapping(value = "/batchDeletes/{batchDeleteDbId}", produces = { "application/json" }, consumes = { |
81 | 81 | "application/json" }, method = RequestMethod.PUT)
|
82 |
| - ResponseEntity<BatchesSingleResponse> batchesBatchDbIdPut( |
83 |
| - @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDbId") String batchDbId, |
84 |
| - @ApiParam(value = "") @Valid @RequestBody BatchNewRequest body, |
| 82 | + ResponseEntity<BatchDeletesSingleResponse> batchDeletesBatchDbIdPut( |
| 83 | + @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDeleteDbId") String batchDbId, |
| 84 | + @ApiParam(value = "") @Valid @RequestBody BatchDeleteNewRequest body, |
85 | 85 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization)
|
86 | 86 | throws BrAPIServerException;
|
87 | 87 |
|
88 |
| - @ApiOperation(value = "Create a New Batch", nickname = "batchesPost", notes = "Create a new batch", response = BatchesListResponse.class, authorizations = { |
89 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
90 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchesListResponse.class), |
| 88 | + @ApiOperation(value = "Create a New Batch Delete", nickname = "batchDeletesPost", notes = "Create a new batch delete", response = BatchDeletesListResponse.class, authorizations = { |
| 89 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 90 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeletesListResponse.class), |
91 | 91 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
92 | 92 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
93 | 93 | @ApiResponse(code = 403, message = "Forbidden", response = String.class) })
|
94 |
| - @RequestMapping(value = "/batches", produces = { "application/json" }, consumes = { |
| 94 | + @RequestMapping(value = "/batchDeletes", produces = { "application/json" }, consumes = { |
95 | 95 | "application/json" }, method = RequestMethod.POST)
|
96 |
| - ResponseEntity<? extends BrAPIResponse> batchesPost(@ApiParam(value = "") @Valid @RequestBody BatchSearchRequest body, |
97 |
| - @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization) |
| 96 | + ResponseEntity<? extends BrAPIResponse> batchDeletesPost(@ApiParam(value = "") @Valid @RequestBody BatchDeleteSearchRequest body, |
| 97 | + @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization) |
98 | 98 | throws BrAPIServerException;
|
99 | 99 |
|
100 |
| - @ApiOperation(value = "Get the results of a Batch search request", nickname = "searchBatchesSearchResultsDbIdGet", notes = "Advanced searching for the batch resource. See Search Services for additional implementation details.", response = BatchesListResponse.class, authorizations = { |
101 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
102 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchesListResponse.class), |
| 100 | + @ApiOperation(value = "Get the results of a Batch Delete search request", nickname = "searchBatchDeletesSearchResultsDbIdGet", notes = "Advanced searching for the batch delete resource. See Search Services for additional implementation details.", response = BatchDeletesListResponse.class, authorizations = { |
| 101 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 102 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeletesListResponse.class), |
103 | 103 | @ApiResponse(code = 202, message = "Accepted", response = Model202AcceptedSearchResponse.class),
|
104 | 104 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
105 | 105 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
106 | 106 | @ApiResponse(code = 403, message = "Forbidden", response = String.class) })
|
107 |
| - @RequestMapping(value = "/search/batches/{searchResultsDbId}", produces = { |
| 107 | + @RequestMapping(value = "/search/batchDeletes/{searchResultsDbId}", produces = { |
108 | 108 | "application/json" }, method = RequestMethod.GET)
|
109 |
| - ResponseEntity<? extends BrAPIResponse> searchBatchesSearchResultsDbIdGet( |
| 109 | + ResponseEntity<? extends BrAPIResponse> searchBatchDeletesSearchResultsDbIdGet( |
110 | 110 | @ApiParam(value = "Permanent unique identifier which references the search results", required = true) @PathVariable("searchResultsDbId") String searchResultsDbId,
|
111 | 111 | @ApiParam(value = "page") @Valid @RequestParam(value = "page", required = false) Integer page,
|
112 | 112 | @ApiParam(value = "pageSize") @Valid @RequestParam(value = "pageSize", required = false) Integer pageSize,
|
113 | 113 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization) throws BrAPIServerException;
|
114 | 114 |
|
115 |
| - @ApiOperation(value = "Delete a specific Batch", nickname = "batchesBatchDbIdDelete", notes = "Delete a specific generic batch", response = BatchesSingleResponse.class, authorizations = { |
116 |
| - @Authorization(value = "AuthorizationToken") }, tags = { "Batches", }) |
117 |
| - @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchesSingleResponse.class), |
| 115 | + @ApiOperation(value = "Delete a specific Batch Delete", nickname = "batchDeletesBatchDbIdDelete", notes = "Delete a specific generic batch delete", response = BatchDeletesSingleResponse.class, authorizations = { |
| 116 | + @Authorization(value = "AuthorizationToken") }, tags = { "BatchDeletes", }) |
| 117 | + @ApiResponses(value = { @ApiResponse(code = 200, message = "OK", response = BatchDeletesSingleResponse.class), |
118 | 118 | @ApiResponse(code = 400, message = "Bad Request", response = String.class),
|
119 | 119 | @ApiResponse(code = 401, message = "Unauthorized", response = String.class),
|
120 | 120 | @ApiResponse(code = 403, message = "Forbidden", response = String.class),
|
121 | 121 | @ApiResponse(code = 404, message = "Not Found", response = String.class) })
|
122 |
| - @RequestMapping(value = "/batches/{batchDbId}", produces = { "application/json" }, method = RequestMethod.DELETE) |
123 |
| - ResponseEntity<BatchesSingleResponse> batchesBatchDbIdDelete( |
124 |
| - @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDbId") String batchDbId, |
| 122 | + @RequestMapping(value = "/batchDeletes/{batchDeleteDbId}", produces = { "application/json" }, method = RequestMethod.DELETE) |
| 123 | + ResponseEntity<BatchDeletesSingleResponse> batchDeletesBatchDbIdDelete( |
| 124 | + @ApiParam(value = "The unique ID of this generic batch", required = true) @PathVariable("batchDeleteDbId") String batchDbId, |
125 | 125 | @ApiParam(value = "hard") @Valid @RequestParam(value = "hardDelete", defaultValue = "false", required = false) boolean hardDelete,
|
126 | 126 | @ApiParam(value = "HTTP HEADER - Token used for Authorization <strong> Bearer {token_string} </strong>") @RequestHeader(value = "Authorization", required = false) String authorization)
|
127 | 127 | throws BrAPIServerException;
|
|
0 commit comments