Line 0
Link Here
|
|
|
1 |
--- |
2 |
/catalog/concerns: |
3 |
get: |
4 |
x-mojo-to: Catalog::Concerns#list |
5 |
operationId: listConcerns |
6 |
tags: |
7 |
- concerns |
8 |
summary: List concerns |
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 |
responses: |
21 |
"200": |
22 |
description: A list of concerns |
23 |
schema: |
24 |
type: array |
25 |
items: |
26 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
27 |
"403": |
28 |
description: Access forbidden |
29 |
schema: |
30 |
$ref: "../swagger.yaml#/definitions/error" |
31 |
"500": |
32 |
description: | |
33 |
Internal server error. Possible `error_code` attribute values: |
34 |
|
35 |
* `internal_server_error` |
36 |
schema: |
37 |
$ref: "../swagger.yaml#/definitions/error" |
38 |
"503": |
39 |
description: Under maintenance |
40 |
schema: |
41 |
$ref: "../swagger.yaml#/definitions/error" |
42 |
x-koha-authorization: |
43 |
permissions: |
44 |
catalogue: "1" |
45 |
post: |
46 |
x-mojo-to: Catalog::Concerns#add |
47 |
operationId: addConcern |
48 |
tags: |
49 |
- concerns |
50 |
summary: Add catalog concern |
51 |
parameters: |
52 |
- name: body |
53 |
in: body |
54 |
description: A JSON object containing informations about the new hold |
55 |
required: true |
56 |
schema: |
57 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
58 |
produces: |
59 |
- application/json |
60 |
responses: |
61 |
"201": |
62 |
description: Concern added |
63 |
schema: |
64 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
65 |
"401": |
66 |
description: Authentication required |
67 |
schema: |
68 |
$ref: "../swagger.yaml#/definitions/error" |
69 |
"403": |
70 |
description: Access forbidden |
71 |
schema: |
72 |
$ref: "../swagger.yaml#/definitions/error" |
73 |
"500": |
74 |
description: | |
75 |
Internal server error. Possible `error_code` attribute values: |
76 |
|
77 |
* `internal_server_error` |
78 |
schema: |
79 |
$ref: "../swagger.yaml#/definitions/error" |
80 |
"503": |
81 |
description: Under maintenance |
82 |
schema: |
83 |
$ref: "../swagger.yaml#/definitions/error" |
84 |
x-koha-authorization: |
85 |
permissions: |
86 |
catalogue: "1" |
87 |
"/catalog/concerns/{concern_id}": |
88 |
get: |
89 |
x-mojo-to: Catalog::Concerns#get |
90 |
operationId: getConcern |
91 |
tags: |
92 |
- concerns |
93 |
summary: Get catalog concern |
94 |
parameters: |
95 |
- $ref: "../swagger.yaml#/parameters/concern_id_pp" |
96 |
produces: |
97 |
- application/json |
98 |
responses: |
99 |
"200": |
100 |
description: A catalog concern |
101 |
schema: |
102 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
103 |
"404": |
104 |
description: Concern not found |
105 |
schema: |
106 |
$ref: "../swagger.yaml#/definitions/error" |
107 |
"500": |
108 |
description: | |
109 |
Internal server error. Possible `error_code` attribute values: |
110 |
|
111 |
* `internal_server_error` |
112 |
schema: |
113 |
$ref: "../swagger.yaml#/definitions/error" |
114 |
"503": |
115 |
description: Under maintenance |
116 |
schema: |
117 |
$ref: "../swagger.yaml#/definitions/error" |
118 |
x-koha-authorization: |
119 |
permissions: |
120 |
catalogue: "1" |
121 |
put: |
122 |
x-mojo-to: Catalog::Concerns#update |
123 |
operationId: updateConcern |
124 |
tags: |
125 |
- concerns |
126 |
summary: Update catalog concern |
127 |
parameters: |
128 |
- $ref: "../swagger.yaml#/parameters/concern_id_pp" |
129 |
- name: body |
130 |
in: body |
131 |
description: A catalog concern object |
132 |
required: true |
133 |
schema: |
134 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
135 |
produces: |
136 |
- application/json |
137 |
responses: |
138 |
"200": |
139 |
description: A catalog concern |
140 |
schema: |
141 |
$ref: "../swagger.yaml#/definitions/catalog_concern" |
142 |
"401": |
143 |
description: Authentication required |
144 |
schema: |
145 |
$ref: "../swagger.yaml#/definitions/error" |
146 |
"403": |
147 |
description: Access forbidden |
148 |
schema: |
149 |
$ref: "../swagger.yaml#/definitions/error" |
150 |
"404": |
151 |
description: Concern not found |
152 |
schema: |
153 |
$ref: "../swagger.yaml#/definitions/error" |
154 |
"500": |
155 |
description: Internal error |
156 |
schema: |
157 |
$ref: "../swagger.yaml#/definitions/error" |
158 |
"503": |
159 |
description: Under maintenance |
160 |
schema: |
161 |
$ref: "../swagger.yaml#/definitions/error" |
162 |
x-koha-authorization: |
163 |
permissions: |
164 |
editcatalogue: edit_catalogue |
165 |
delete: |
166 |
x-mojo-to: Catalog::Concerns#delete |
167 |
operationId: deleteConcern |
168 |
tags: |
169 |
- concerns |
170 |
summary: Delete catalog concern |
171 |
parameters: |
172 |
- $ref: "../swagger.yaml#/parameters/concern_id_pp" |
173 |
produces: |
174 |
- application/json |
175 |
responses: |
176 |
"204": |
177 |
description: Concern deleted |
178 |
"401": |
179 |
description: Authentication required |
180 |
schema: |
181 |
$ref: "../swagger.yaml#/definitions/error" |
182 |
"403": |
183 |
description: Access forbidden |
184 |
schema: |
185 |
$ref: "../swagger.yaml#/definitions/error" |
186 |
"404": |
187 |
description: Concern not found |
188 |
schema: |
189 |
$ref: "../swagger.yaml#/definitions/error" |
190 |
"500": |
191 |
description: Internal error |
192 |
schema: |
193 |
$ref: "../swagger.yaml#/definitions/error" |
194 |
"503": |
195 |
description: Under maintenance |
196 |
schema: |
197 |
$ref: "../swagger.yaml#/definitions/error" |
198 |
x-koha-authorization: |
199 |
permissions: |
200 |
editcatalogue: edit_catalogue |