Line 0
Link Here
|
|
|
1 |
--- |
2 |
/tickets: |
3 |
get: |
4 |
x-mojo-to: Tickets#list |
5 |
operationId: listTickets |
6 |
tags: |
7 |
- tickets |
8 |
summary: List tickets |
9 |
produces: |
10 |
- application/json |
11 |
parameters: |
12 |
- $ref: "../swagger.yaml#/parameters/match" |
13 |
- $ref: "../swagger.yaml#/parameters/order_by" |
14 |
- $ref: "../swagger.yaml#/parameters/page" |
15 |
- $ref: "../swagger.yaml#/parameters/per_page" |
16 |
- $ref: "../swagger.yaml#/parameters/q_param" |
17 |
- $ref: "../swagger.yaml#/parameters/q_body" |
18 |
- $ref: "../swagger.yaml#/parameters/q_header" |
19 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
20 |
- name: x-koha-embed |
21 |
in: header |
22 |
required: false |
23 |
description: Embed list sent as a request header |
24 |
type: array |
25 |
items: |
26 |
type: string |
27 |
enum: |
28 |
- reporter |
29 |
- resolver |
30 |
- biblio |
31 |
collectionFormat: csv |
32 |
responses: |
33 |
"200": |
34 |
description: A list of tickets |
35 |
schema: |
36 |
type: array |
37 |
items: |
38 |
$ref: "../swagger.yaml#/definitions/ticket" |
39 |
"403": |
40 |
description: Access forbidden |
41 |
schema: |
42 |
$ref: "../swagger.yaml#/definitions/error" |
43 |
"500": |
44 |
description: | |
45 |
Internal server error. Possible `error_code` attribute values: |
46 |
|
47 |
* `internal_server_error` |
48 |
schema: |
49 |
$ref: "../swagger.yaml#/definitions/error" |
50 |
"503": |
51 |
description: Under maintenance |
52 |
schema: |
53 |
$ref: "../swagger.yaml#/definitions/error" |
54 |
x-koha-authorization: |
55 |
permissions: |
56 |
catalogue: "1" |
57 |
post: |
58 |
x-mojo-to: Tickets#add |
59 |
operationId: addTicket |
60 |
tags: |
61 |
- tickets |
62 |
summary: Add ticket |
63 |
parameters: |
64 |
- name: body |
65 |
in: body |
66 |
description: A JSON object containing informations about the new hold |
67 |
required: true |
68 |
schema: |
69 |
$ref: "../swagger.yaml#/definitions/ticket" |
70 |
produces: |
71 |
- application/json |
72 |
responses: |
73 |
"201": |
74 |
description: Ticket added |
75 |
schema: |
76 |
$ref: "../swagger.yaml#/definitions/ticket" |
77 |
"401": |
78 |
description: Authentication required |
79 |
schema: |
80 |
$ref: "../swagger.yaml#/definitions/error" |
81 |
"403": |
82 |
description: Access forbidden |
83 |
schema: |
84 |
$ref: "../swagger.yaml#/definitions/error" |
85 |
"500": |
86 |
description: | |
87 |
Internal server error. Possible `error_code` attribute values: |
88 |
|
89 |
* `internal_server_error` |
90 |
schema: |
91 |
$ref: "../swagger.yaml#/definitions/error" |
92 |
"503": |
93 |
description: Under maintenance |
94 |
schema: |
95 |
$ref: "../swagger.yaml#/definitions/error" |
96 |
x-koha-authorization: |
97 |
permissions: |
98 |
catalogue: "1" |
99 |
"/tickets/{ticket_id}": |
100 |
get: |
101 |
x-mojo-to: Tickets#get |
102 |
operationId: getTicket |
103 |
tags: |
104 |
- tickets |
105 |
summary: Get ticket |
106 |
parameters: |
107 |
- $ref: "../swagger.yaml#/parameters/ticket_id_pp" |
108 |
produces: |
109 |
- application/json |
110 |
responses: |
111 |
"200": |
112 |
description: A ticket |
113 |
schema: |
114 |
$ref: "../swagger.yaml#/definitions/ticket" |
115 |
"404": |
116 |
description: Ticket not found |
117 |
schema: |
118 |
$ref: "../swagger.yaml#/definitions/error" |
119 |
"500": |
120 |
description: | |
121 |
Internal server error. Possible `error_code` attribute values: |
122 |
|
123 |
* `internal_server_error` |
124 |
schema: |
125 |
$ref: "../swagger.yaml#/definitions/error" |
126 |
"503": |
127 |
description: Under maintenance |
128 |
schema: |
129 |
$ref: "../swagger.yaml#/definitions/error" |
130 |
x-koha-authorization: |
131 |
permissions: |
132 |
catalogue: "1" |
133 |
put: |
134 |
x-mojo-to: Tickets#update |
135 |
operationId: updateTicket |
136 |
tags: |
137 |
- tickets |
138 |
summary: Update ticket |
139 |
parameters: |
140 |
- $ref: "../swagger.yaml#/parameters/ticket_id_pp" |
141 |
- name: body |
142 |
in: body |
143 |
description: A ticket object |
144 |
required: true |
145 |
schema: |
146 |
$ref: "../swagger.yaml#/definitions/ticket" |
147 |
produces: |
148 |
- application/json |
149 |
responses: |
150 |
"200": |
151 |
description: A ticket |
152 |
schema: |
153 |
$ref: "../swagger.yaml#/definitions/ticket" |
154 |
"401": |
155 |
description: Authentication required |
156 |
schema: |
157 |
$ref: "../swagger.yaml#/definitions/error" |
158 |
"403": |
159 |
description: Access forbidden |
160 |
schema: |
161 |
$ref: "../swagger.yaml#/definitions/error" |
162 |
"404": |
163 |
description: Ticket not found |
164 |
schema: |
165 |
$ref: "../swagger.yaml#/definitions/error" |
166 |
"500": |
167 |
description: Internal error |
168 |
schema: |
169 |
$ref: "../swagger.yaml#/definitions/error" |
170 |
"503": |
171 |
description: Under maintenance |
172 |
schema: |
173 |
$ref: "../swagger.yaml#/definitions/error" |
174 |
x-koha-authorization: |
175 |
permissions: |
176 |
editcatalogue: edit_catalogue |
177 |
delete: |
178 |
x-mojo-to: Tickets#delete |
179 |
operationId: deleteTicket |
180 |
tags: |
181 |
- tickets |
182 |
summary: Delete ticket |
183 |
parameters: |
184 |
- $ref: "../swagger.yaml#/parameters/ticket_id_pp" |
185 |
produces: |
186 |
- application/json |
187 |
responses: |
188 |
"204": |
189 |
description: Ticket deleted |
190 |
"401": |
191 |
description: Authentication required |
192 |
schema: |
193 |
$ref: "../swagger.yaml#/definitions/error" |
194 |
"403": |
195 |
description: Access forbidden |
196 |
schema: |
197 |
$ref: "../swagger.yaml#/definitions/error" |
198 |
"404": |
199 |
description: Ticket not found |
200 |
schema: |
201 |
$ref: "../swagger.yaml#/definitions/error" |
202 |
"500": |
203 |
description: Internal error |
204 |
schema: |
205 |
$ref: "../swagger.yaml#/definitions/error" |
206 |
"503": |
207 |
description: Under maintenance |
208 |
schema: |
209 |
$ref: "../swagger.yaml#/definitions/error" |
210 |
x-koha-authorization: |
211 |
permissions: |
212 |
editcatalogue: edit_catalogue |
213 |
/public/tickets: |
214 |
post: |
215 |
x-mojo-to: Tickets#add |
216 |
operationId: addTicketPublic |
217 |
tags: |
218 |
- tickets |
219 |
summary: Add ticket |
220 |
parameters: |
221 |
- name: body |
222 |
in: body |
223 |
description: A JSON object containing informations about the new hold |
224 |
required: true |
225 |
schema: |
226 |
$ref: "../swagger.yaml#/definitions/ticket" |
227 |
produces: |
228 |
- application/json |
229 |
responses: |
230 |
"201": |
231 |
description: Ticket added |
232 |
schema: |
233 |
$ref: "../swagger.yaml#/definitions/ticket" |
234 |
"401": |
235 |
description: Authentication required |
236 |
schema: |
237 |
$ref: "../swagger.yaml#/definitions/error" |
238 |
"403": |
239 |
description: Access forbidden |
240 |
schema: |
241 |
$ref: "../swagger.yaml#/definitions/error" |
242 |
"500": |
243 |
description: | |
244 |
Internal server error. Possible `error_code` attribute values: |
245 |
|
246 |
* `internal_server_error` |
247 |
schema: |
248 |
$ref: "../swagger.yaml#/definitions/error" |
249 |
"503": |
250 |
description: Under maintenance |
251 |
schema: |
252 |
$ref: "../swagger.yaml#/definitions/error" |