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