Lines 1-12
Link Here
|
1 |
--- |
1 |
--- |
2 |
"/public/lists": |
2 |
/lists: |
3 |
get: |
3 |
get: |
4 |
x-mojo-to: Lists#list_public |
4 |
x-mojo-to: Lists#list_public |
5 |
operationId: listListsPublic |
|
|
6 |
description: "This resource returns a list of existing bibliographic lists." |
5 |
description: "This resource returns a list of existing bibliographic lists." |
7 |
summary: List bibliographic lists |
6 |
x-koha-authorization: |
|
|
7 |
permissions: |
8 |
tools: manage_patron_lists |
9 |
operationId: listLists |
8 |
tags: |
10 |
tags: |
9 |
- lists |
11 |
- lists |
|
|
12 |
summary: List bibliographic lists |
13 |
produces: |
14 |
- application/json |
10 |
parameters: |
15 |
parameters: |
11 |
- name: only_mine |
16 |
- name: only_mine |
12 |
in: query |
17 |
in: query |
Lines 25-32
Link Here
|
25 |
- $ref: "../swagger.yaml#/parameters/q_param" |
30 |
- $ref: "../swagger.yaml#/parameters/q_param" |
26 |
- $ref: "../swagger.yaml#/parameters/q_body" |
31 |
- $ref: "../swagger.yaml#/parameters/q_body" |
27 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
32 |
- $ref: "../swagger.yaml#/parameters/request_id_header" |
28 |
produces: |
|
|
29 |
- application/json |
30 |
responses: |
33 |
responses: |
31 |
"200": |
34 |
"200": |
32 |
description: A list of lists |
35 |
description: A list of lists |
Lines 40-46
Link Here
|
40 |
|
43 |
|
41 |
* `bad_request` |
44 |
* `bad_request` |
42 |
* `invalid_query` |
45 |
* `invalid_query` |
43 |
* `only_mine_forbidden` |
|
|
44 |
schema: |
46 |
schema: |
45 |
$ref: "../swagger.yaml#/definitions/error" |
47 |
$ref: "../swagger.yaml#/definitions/error" |
46 |
"403": |
48 |
"403": |
Lines 58-60
Link Here
|
58 |
description: Under maintenance |
60 |
description: Under maintenance |
59 |
schema: |
61 |
schema: |
60 |
$ref: "../swagger.yaml#/definitions/error" |
62 |
$ref: "../swagger.yaml#/definitions/error" |
|
|
63 |
|
64 |
|
65 |
post: |
66 |
x-mojo-to: Lists#add |
67 |
x-koha-authorization: |
68 |
permissions: |
69 |
tools: manage_patron_lists |
70 |
operationId: createList |
71 |
tags: |
72 |
- lists |
73 |
description: "This resource creates a bibliographic list owned by a specified user." |
74 |
summary: Create a new list |
75 |
produces: |
76 |
- application/json |
77 |
parameters: |
78 |
- name: body |
79 |
in: body |
80 |
description: A JSON object containing information about the new list |
81 |
required: true |
82 |
schema: |
83 |
$ref: "../swagger.yaml#/definitions/list" |
84 |
responses: |
85 |
"201": |
86 |
description: List added |
87 |
schema: |
88 |
$ref: "../swagger.yaml#/definitions/list" |
89 |
"400": |
90 |
description: Bad request |
91 |
schema: |
92 |
$ref: "../swagger.yaml#/definitions/error" |
93 |
"401": |
94 |
description: Authentication required |
95 |
schema: |
96 |
$ref: "../swagger.yaml#/definitions/error" |
97 |
"403": |
98 |
description: Access forbidden |
99 |
schema: |
100 |
$ref: "../swagger.yaml#/definitions/error" |
101 |
"500": |
102 |
description: | |
103 |
Internal server error. Possible `error_code` attribute values: |
104 |
|
105 |
* `internal_server_error` |
106 |
schema: |
107 |
$ref: "../swagger.yaml#/definitions/error" |
108 |
"503": |
109 |
description: Under maintenance |
110 |
schema: |
111 |
$ref: "../swagger.yaml#/definitions/error" |
112 |
|
113 |
/lists/{list_id}: |
114 |
get: |
115 |
x-mojo-to: Lists#public_get |
116 |
x-koha-authorization: |
117 |
permissions: |
118 |
tools: manage_patron_lists |
119 |
description: "This resource returns information on a specific existing bibliographic list." |
120 |
operationId: readList |
121 |
tags: |
122 |
- lists |
123 |
summary: Retrieve a specific list |
124 |
produces: |
125 |
- application/json |
126 |
parameters: |
127 |
- $ref: "../swagger.yaml#/parameters/list_id_pp" |
128 |
responses: |
129 |
"200": |
130 |
description: OK |
131 |
schema: |
132 |
$ref: "../swagger.yaml#/definitions/list" |
133 |
"400": |
134 |
description: Bad request |
135 |
schema: |
136 |
$ref: "../swagger.yaml#/definitions/error" |
137 |
"403": |
138 |
description: Access forbidden |
139 |
schema: |
140 |
$ref: "../swagger.yaml#/definitions/error" |
141 |
"404": |
142 |
description: Not found |
143 |
schema: |
144 |
$ref: "../swagger.yaml#/definitions/error" |
145 |
"500": |
146 |
description: | |
147 |
Internal server error. Possible `error_code` attribute values: |
148 |
|
149 |
* `internal_server_error` |
150 |
schema: |
151 |
$ref: "../swagger.yaml#/definitions/error" |
152 |
"503": |
153 |
description: Under maintenance |
154 |
schema: |
155 |
$ref: "../swagger.yaml#/definitions/error" |
156 |
|
157 |
put: |
158 |
x-mojo-to: Lists#update |
159 |
x-koha-authorization: |
160 |
permissions: |
161 |
tools: manage_patron_lists |
162 |
operationId: updateList |
163 |
description: 'Update a specific list' |
164 |
tags: |
165 |
- lists |
166 |
summary: Update a specific list |
167 |
produces: |
168 |
- application/json |
169 |
parameters: |
170 |
- $ref: "../swagger.yaml#/parameters/list_id_pp" |
171 |
- name: body |
172 |
in: body |
173 |
description: A list object |
174 |
required: true |
175 |
schema: |
176 |
$ref: "../swagger.yaml#/definitions/list" |
177 |
responses: |
178 |
"200": |
179 |
description: A city |
180 |
schema: |
181 |
$ref: "../swagger.yaml#/definitions/list" |
182 |
"400": |
183 |
description: Bad request |
184 |
schema: |
185 |
$ref: "../swagger.yaml#/definitions/error" |
186 |
"401": |
187 |
description: Authentication required |
188 |
schema: |
189 |
$ref: "../swagger.yaml#/definitions/error" |
190 |
"403": |
191 |
description: Access forbidden |
192 |
schema: |
193 |
$ref: "../swagger.yaml#/definitions/error" |
194 |
"404": |
195 |
description: Not found |
196 |
schema: |
197 |
$ref: "../swagger.yaml#/definitions/error" |
198 |
"500": |
199 |
description: | |
200 |
Internal server error. Possible `error_code` attribute values: |
201 |
|
202 |
* `internal_server_error` |
203 |
schema: |
204 |
$ref: "../swagger.yaml#/definitions/error" |
205 |
"503": |
206 |
description: Under maintenance |
207 |
schema: |
208 |
$ref: "../swagger.yaml#/definitions/error" |
209 |
|
210 |
delete: |
211 |
x-mojo-to: Lists#delete |
212 |
x-koha-authorization: |
213 |
permissions: |
214 |
tools: manage_patron_lists |
215 |
operationId: deleteList |
216 |
tags: |
217 |
- lists |
218 |
summary: Delete a specific list |
219 |
produces: |
220 |
- application/json |
221 |
parameters: |
222 |
- $ref: "../swagger.yaml#/parameters/list_id_pp" |
223 |
responses: |
224 |
"204": |
225 |
description: List deleted |
226 |
"401": |
227 |
description: Authentication required |
228 |
schema: |
229 |
$ref: "../swagger.yaml#/definitions/error" |
230 |
"403": |
231 |
description: Access forbidden |
232 |
schema: |
233 |
$ref: "../swagger.yaml#/definitions/error" |
234 |
"404": |
235 |
description: List not found |
236 |
schema: |
237 |
$ref: "../swagger.yaml#/definitions/error" |
238 |
"500": |
239 |
description: Internal error |
240 |
schema: |
241 |
$ref: "../swagger.yaml#/definitions/error" |
242 |
"503": |
243 |
description: Under maintenance |
244 |
schema: |
245 |
$ref: "../swagger.yaml#/definitions/error" |