View | Details | Raw Unified | Return to bug 32923
Collapse All | Expand All

(-)a/api/v1/swagger/paths/biblios_item_groups.yaml (-8 / +40 lines)
Lines 12-17 Link Here
12
      description: Internal identifier for the parent bibliographic record
12
      description: Internal identifier for the parent bibliographic record
13
      required: true
13
      required: true
14
      type: string
14
      type: string
15
    - name: x-koha-embed
16
      in: header
17
      required: false
18
      description: Embed list sent as a request header
19
      type: array
20
      items:
21
        type: string
22
        enum:
23
          - items
24
      collectionFormat: csv
15
    - "$ref": "../swagger.yaml#/parameters/match"
25
    - "$ref": "../swagger.yaml#/parameters/match"
16
    - "$ref": "../swagger.yaml#/parameters/order_by"
26
    - "$ref": "../swagger.yaml#/parameters/order_by"
17
    - "$ref": "../swagger.yaml#/parameters/page"
27
    - "$ref": "../swagger.yaml#/parameters/page"
Lines 47-54 Link Here
47
    x-koha-authorization:
57
    x-koha-authorization:
48
      permissions:
58
      permissions:
49
        catalogue: "manage_item_groups"
59
        catalogue: "manage_item_groups"
50
    x-koha-embed:
51
    - items
52
  post:
60
  post:
53
    x-mojo-to: Biblios::ItemGroups#add
61
    x-mojo-to: Biblios::ItemGroups#add
54
    operationId: addItemGroup
62
    operationId: addItemGroup
Lines 131-136 Link Here
131
      description: Internal identifier for the item_group
139
      description: Internal identifier for the item_group
132
      required: true
140
      required: true
133
      type: string
141
      type: string
142
    - name: x-koha-embed
143
      in: header
144
      required: false
145
      description: Embed list sent as a request header
146
      type: array
147
      items:
148
        type: string
149
        enum:
150
          - items
151
      collectionFormat: csv
134
    produces:
152
    produces:
135
    - application/yaml
153
    - application/yaml
136
    responses:
154
    responses:
Lines 154-161 Link Here
154
        description: Under maintenance
172
        description: Under maintenance
155
        schema:
173
        schema:
156
          "$ref": "../swagger.yaml#/definitions/error"
174
          "$ref": "../swagger.yaml#/definitions/error"
157
    x-koha-embed:
158
    - items
159
    x-koha-authorization:
175
    x-koha-authorization:
160
      permissions:
176
      permissions:
161
        catalogue: "manage_item_groups"
177
        catalogue: "manage_item_groups"
Lines 190-195 Link Here
190
            type: integer
206
            type: integer
191
            description: Position in waiting queue
207
            description: Position in waiting queue
192
        additionalProperties: false
208
        additionalProperties: false
209
    - name: x-koha-embed
210
      in: header
211
      required: false
212
      description: Embed list sent as a request header
213
      type: array
214
      items:
215
        type: string
216
        enum:
217
          - items
218
      collectionFormat: csv
193
    produces:
219
    produces:
194
    - application/yaml
220
    - application/yaml
195
    responses:
221
    responses:
Lines 224-231 Link Here
224
    x-koha-authorization:
250
    x-koha-authorization:
225
      permissions:
251
      permissions:
226
        catalogue: "manage_item_groups"
252
        catalogue: "manage_item_groups"
227
    x-koha-embed:
228
    - items
229
  delete:
253
  delete:
230
    x-mojo-to: Biblios::ItemGroups#delete
254
    x-mojo-to: Biblios::ItemGroups#delete
231
    operationId: deleteItemGroup
255
    operationId: deleteItemGroup
Lines 302-307 Link Here
302
            type: integer
326
            type: integer
303
            description: Internal identifier for an item to be linked
327
            description: Internal identifier for an item to be linked
304
        additionalProperties: false
328
        additionalProperties: false
329
    - name: x-koha-embed
330
      in: header
331
      required: false
332
      description: Embed list sent as a request header
333
      type: array
334
      items:
335
        type: string
336
        enum:
337
          - items
338
      collectionFormat: csv
305
    produces:
339
    produces:
306
    - application/yaml
340
    - application/yaml
307
    responses:
341
    responses:
Lines 334-341 Link Here
334
    x-koha-authorization:
368
    x-koha-authorization:
335
      permissions:
369
      permissions:
336
        catalogue: "manage_item_groups"
370
        catalogue: "manage_item_groups"
337
    x-koha-embed:
338
    - items
339
"/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}":
371
"/biblios/{biblio_id}/item_groups/{item_group_id}/items/{item_id}":
340
  delete:
372
  delete:
341
    x-mojo-to: Biblios::ItemGroups::Items#delete
373
    x-mojo-to: Biblios::ItemGroups::Items#delete
(-)a/api/v1/swagger/paths/checkouts.yaml (-2 lines)
Lines 235-242 Link Here
235
    x-koha-authorization:
235
    x-koha-authorization:
236
      permissions:
236
      permissions:
237
        circulate: circulate_remaining_permissions
237
        circulate: circulate_remaining_permissions
238
    x-koha-embed:
239
        - renewer
240
"/checkouts/{checkout_id}/allows_renewal":
238
"/checkouts/{checkout_id}/allows_renewal":
241
  get:
239
  get:
242
    x-mojo-to: Checkouts#allows_renewal
240
    x-mojo-to: Checkouts#allows_renewal
(-)a/api/v1/swagger/paths/erm_agreements.yaml (-18 / +33 lines)
Lines 165-170 Link Here
165
      - application/json
165
      - application/json
166
    parameters:
166
    parameters:
167
      - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
167
      - $ref: "../swagger.yaml#/parameters/agreement_id_pp"
168
      - name: x-koha-embed
169
        in: header
170
        required: false
171
        description: Embed list sent as a request header
172
        type: array
173
        items:
174
          type: string
175
          enum:
176
            - periods
177
            - user_roles
178
            - user_roles.patron
179
            - agreement_licenses
180
            - agreement_licenses.license
181
            - agreement_relationships
182
            - agreement_relationships.agreement
183
            - agreement_relationships.related_agreement
184
            - documents
185
            - packages
186
        collectionFormat: csv
168
    responses:
187
    responses:
169
      200:
188
      200:
170
        description: An agreement
189
        description: An agreement
Lines 196-212 Link Here
196
    x-koha-authorization:
215
    x-koha-authorization:
197
      permissions:
216
      permissions:
198
        erm: 1
217
        erm: 1
199
    x-koha-embed:
200
      - periods
201
      - user_roles
202
      - user_roles.patron
203
      - agreement_licenses
204
      - agreement_licenses.license
205
      - agreement_relationships
206
      - agreement_relationships.agreement
207
      - agreement_relationships.related_agreement
208
      - documents
209
      - packages
210
  put:
218
  put:
211
    x-mojo-to: ERM::Agreements#update
219
    x-mojo-to: ERM::Agreements#update
212
    operationId: updateErmAgreements
220
    operationId: updateErmAgreements
Lines 225-231 Link Here
225
        required: true
233
        required: true
226
        schema:
234
        schema:
227
          $ref: "../swagger.yaml#/definitions/erm_agreement"
235
          $ref: "../swagger.yaml#/definitions/erm_agreement"
228
236
      - name: x-koha-embed
237
        in: header
238
        required: false
239
        description: Embed list sent as a request header
240
        type: array
241
        items:
242
          type: string
243
          enum:
244
            - periods
245
            - user_roles
246
            - agreement_licenses
247
            - agreement_relationships
248
            - documents
249
        collectionFormat: csv
229
    responses:
250
    responses:
230
      200:
251
      200:
231
        description: A successfully updated agreement
252
        description: A successfully updated agreement
Lines 265-276 Link Here
265
    x-koha-authorization:
286
    x-koha-authorization:
266
      permissions:
287
      permissions:
267
        erm: 1
288
        erm: 1
268
    x-koha-embed:
269
      - periods
270
      - user_roles
271
      - agreement_licenses
272
      - agreement_relationships
273
      - documents
274
  delete:
289
  delete:
275
    x-mojo-to: ERM::Agreements#delete
290
    x-mojo-to: ERM::Agreements#delete
276
    operationId: deleteErmAgreements
291
    operationId: deleteErmAgreements
(-)a/api/v1/swagger/paths/erm_eholdings_packages.yaml (-9 / +33 lines)
Lines 61-66 Link Here
61
      - $ref: "../swagger.yaml#/parameters/q_param"
61
      - $ref: "../swagger.yaml#/parameters/q_param"
62
      - $ref: "../swagger.yaml#/parameters/q_body"
62
      - $ref: "../swagger.yaml#/parameters/q_body"
63
      - $ref: "../swagger.yaml#/parameters/q_header"
63
      - $ref: "../swagger.yaml#/parameters/q_header"
64
      - name: x-koha-embed
65
        in: header
66
        required: false
67
        description: Embed list sent as a request header
68
        type: array
69
        items:
70
          type: string
71
          enum:
72
            - vendors
73
            - resources+count
74
        collectionFormat: csv
64
    responses:
75
    responses:
65
      200:
76
      200:
66
        description: A list of package
77
        description: A list of package
Lines 89-97 Link Here
89
    x-koha-authorization:
100
    x-koha-authorization:
90
      permissions:
101
      permissions:
91
        erm: 1
102
        erm: 1
92
    x-koha-embed:
93
      - vendors
94
      - resources+count
95
  post:
103
  post:
96
    x-mojo-to: ERM::EHoldings::Packages#add
104
    x-mojo-to: ERM::EHoldings::Packages#add
97
    operationId: addErmEHoldingsPackages
105
    operationId: addErmEHoldingsPackages
Lines 164-169 Link Here
164
        required: true
172
        required: true
165
        type: string
173
        type: string
166
      - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
174
      - $ref: "../swagger.yaml#/parameters/eholdings_package_id_pp"
175
      - name: x-koha-embed
176
        in: header
177
        required: false
178
        description: Embed list sent as a request header
179
        type: array
180
        items:
181
          type: string
182
          enum:
183
            - agreements
184
            - resources
185
        collectionFormat: csv
167
    responses:
186
    responses:
168
      200:
187
      200:
169
        description: A package
188
        description: A package
Lines 195-203 Link Here
195
    x-koha-authorization:
214
    x-koha-authorization:
196
      permissions:
215
      permissions:
197
        erm: 1
216
        erm: 1
198
    x-koha-embed:
199
      - agreements
200
      - resources
201
  put:
217
  put:
202
    x-mojo-to: ERM::EHoldings::Packages#update
218
    x-mojo-to: ERM::EHoldings::Packages#update
203
    operationId: updateErmEHoldingsPackages
219
    operationId: updateErmEHoldingsPackages
Lines 216-221 Link Here
216
        required: true
232
        required: true
217
        schema:
233
        schema:
218
          $ref: "../swagger.yaml#/definitions/erm_eholdings_package"
234
          $ref: "../swagger.yaml#/definitions/erm_eholdings_package"
235
      - name: x-koha-embed
236
        in: header
237
        required: false
238
        description: Embed list sent as a request header
239
        type: array
240
        items:
241
          type: string
242
          enum:
243
            - agreements
244
            - resources
245
        collectionFormat: csv
219
    responses:
246
    responses:
220
      200:
247
      200:
221
        description: A successfully updated package
248
        description: A successfully updated package
Lines 251-259 Link Here
251
    x-koha-authorization:
278
    x-koha-authorization:
252
      permissions:
279
      permissions:
253
        erm: 1
280
        erm: 1
254
    x-koha-embed:
255
      - agreements
256
      - resources
257
  delete:
281
  delete:
258
    x-mojo-to: ERM::EHoldings::Packages#delete
282
    x-mojo-to: ERM::EHoldings::Packages#delete
259
    operationId: deleteErmEHoldingsPackages
283
    operationId: deleteErmEHoldingsPackages
(-)a/api/v1/swagger/paths/erm_eholdings_packages_resources.yaml (-2 / +10 lines)
Lines 42-47 Link Here
42
      - $ref: "../swagger.yaml#/parameters/q_param"
42
      - $ref: "../swagger.yaml#/parameters/q_param"
43
      - $ref: "../swagger.yaml#/parameters/q_body"
43
      - $ref: "../swagger.yaml#/parameters/q_body"
44
      - $ref: "../swagger.yaml#/parameters/q_header"
44
      - $ref: "../swagger.yaml#/parameters/q_header"
45
      - name: x-koha-embed
46
        in: header
47
        required: false
48
        description: Embed list sent as a request header
49
        type: array
50
        items:
51
          type: string
52
          enum:
53
            - title.publication_title
54
        collectionFormat: csv
45
    responses:
55
    responses:
46
      200:
56
      200:
47
        description: A list of eHoldings resources
57
        description: A list of eHoldings resources
Lines 70-74 Link Here
70
    x-koha-authorization:
80
    x-koha-authorization:
71
      permissions:
81
      permissions:
72
        erm: 1
82
        erm: 1
73
    x-koha-embed:
74
      - title.publication_title
(-)a/api/v1/swagger/paths/erm_eholdings_titles.yaml (-6 / +22 lines)
Lines 251-256 Link Here
251
        required: true
251
        required: true
252
        type: string
252
        type: string
253
      - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
253
      - $ref: "../swagger.yaml#/parameters/eholdings_title_id_pp"
254
      - name: x-koha-embed
255
        in: header
256
        required: false
257
        description: Embed list sent as a request header
258
        type: array
259
        items:
260
          type: string
261
          enum:
262
            - resources
263
            - resources.package
264
        collectionFormat: csv
254
    responses:
265
    responses:
255
      200:
266
      200:
256
        description: An eHolding title
267
        description: An eHolding title
Lines 282-290 Link Here
282
    x-koha-authorization:
293
    x-koha-authorization:
283
      permissions:
294
      permissions:
284
        erm: 1
295
        erm: 1
285
    x-koha-embed:
286
      - resources
287
      - resources.package
288
  put:
296
  put:
289
    x-mojo-to: ERM::EHoldings::Titles#update
297
    x-mojo-to: ERM::EHoldings::Titles#update
290
    operationId: updateErmEHoldingsTitles
298
    operationId: updateErmEHoldingsTitles
Lines 303-308 Link Here
303
        required: true
311
        required: true
304
        schema:
312
        schema:
305
          $ref: "../swagger.yaml#/definitions/erm_eholdings_title"
313
          $ref: "../swagger.yaml#/definitions/erm_eholdings_title"
314
      - name: x-koha-embed
315
        in: header
316
        required: false
317
        description: Embed list sent as a request header
318
        type: array
319
        items:
320
          type: string
321
          enum:
322
            - resources
323
            - resources.package
324
        collectionFormat: csv
306
    responses:
325
    responses:
307
      200:
326
      200:
308
        description: A successfully updated title
327
        description: A successfully updated title
Lines 338-346 Link Here
338
    x-koha-authorization:
357
    x-koha-authorization:
339
      permissions:
358
      permissions:
340
        erm: 1
359
        erm: 1
341
    x-koha-embed:
342
      - resources
343
      - resources.package
344
  delete:
360
  delete:
345
    x-mojo-to: ERM::EHoldings::Titles#delete
361
    x-mojo-to: ERM::EHoldings::Titles#delete
346
    operationId: deleteErmEHoldingsTitles
362
    operationId: deleteErmEHoldingsTitles
(-)a/api/v1/swagger/paths/erm_eholdings_titles_resources.yaml (-2 / +10 lines)
Lines 37-42 Link Here
37
      - $ref: "../swagger.yaml#/parameters/q_param"
37
      - $ref: "../swagger.yaml#/parameters/q_param"
38
      - $ref: "../swagger.yaml#/parameters/q_body"
38
      - $ref: "../swagger.yaml#/parameters/q_body"
39
      - $ref: "../swagger.yaml#/parameters/q_header"
39
      - $ref: "../swagger.yaml#/parameters/q_header"
40
      - name: x-koha-embed
41
        in: header
42
        required: false
43
        description: Embed list sent as a request header
44
        type: array
45
        items:
46
          type: string
47
          enum:
48
            - title.publication_title
49
        collectionFormat: csv
40
    responses:
50
    responses:
41
      200:
51
      200:
42
        description: A list of eHoldings resources
52
        description: A list of eHoldings resources
Lines 65-69 Link Here
65
    x-koha-authorization:
75
    x-koha-authorization:
66
      permissions:
76
      permissions:
67
        erm: 1
77
        erm: 1
68
    x-koha-embed:
69
      - title.publication_title
(-)a/api/v1/swagger/paths/erm_licenses.yaml (-8 / +23 lines)
Lines 150-155 Link Here
150
      - application/json
150
      - application/json
151
    parameters:
151
    parameters:
152
      - $ref: "../swagger.yaml#/parameters/license_id_pp"
152
      - $ref: "../swagger.yaml#/parameters/license_id_pp"
153
      - name: x-koha-embed
154
        in: header
155
        required: false
156
        description: Embed list sent as a request header
157
        type: array
158
        items:
159
          type: string
160
          enum:
161
            - user_roles
162
            - user_roles.patron
163
            - documents
164
        collectionFormat: csv
153
    responses:
165
    responses:
154
      200:
166
      200:
155
        description: license
167
        description: license
Lines 181-190 Link Here
181
    x-koha-authorization:
193
    x-koha-authorization:
182
      permissions:
194
      permissions:
183
        erm: 1
195
        erm: 1
184
    x-koha-embed:
185
      - user_roles
186
      - user_roles.patron
187
      - documents
188
  put:
196
  put:
189
    x-mojo-to: ERM::Licenses#update
197
    x-mojo-to: ERM::Licenses#update
190
    operationId: updateERMlicenses
198
    operationId: updateERMlicenses
Lines 203-209 Link Here
203
        required: true
211
        required: true
204
        schema:
212
        schema:
205
          $ref: "../swagger.yaml#/definitions/erm_license"
213
          $ref: "../swagger.yaml#/definitions/erm_license"
206
214
      - name: x-koha-embed
215
        in: header
216
        required: false
217
        description: Embed list sent as a request header
218
        type: array
219
        items:
220
          type: string
221
          enum:
222
            - user_roles
223
            - documents
224
        collectionFormat: csv
207
    responses:
225
    responses:
208
      200:
226
      200:
209
        description: a successfully updated license
227
        description: a successfully updated license
Lines 243-251 Link Here
243
    x-koha-authorization:
261
    x-koha-authorization:
244
      permissions:
262
      permissions:
245
        erm: 1
263
        erm: 1
246
    x-koha-embed:
247
      - user_roles
248
      - documents
249
  delete:
264
  delete:
250
    x-mojo-to: ERM::Licenses#delete
265
    x-mojo-to: ERM::Licenses#delete
251
    operationId: deleteERMlicenses
266
    operationId: deleteERMlicenses
(-)a/api/v1/swagger/paths/erm_users.yaml (-2 / +10 lines)
Lines 15-20 Link Here
15
      - $ref: "../swagger.yaml#/parameters/q_param"
15
      - $ref: "../swagger.yaml#/parameters/q_param"
16
      - $ref: "../swagger.yaml#/parameters/q_body"
16
      - $ref: "../swagger.yaml#/parameters/q_body"
17
      - $ref: "../swagger.yaml#/parameters/q_header"
17
      - $ref: "../swagger.yaml#/parameters/q_header"
18
      - name: x-koha-embed
19
        in: header
20
        required: false
21
        description: Embed list sent as a request header
22
        type: array
23
        items:
24
          type: string
25
          enum:
26
            - extended_attributes
27
        collectionFormat: csv
18
    produces:
28
    produces:
19
      - application/json
29
      - application/json
20
    responses:
30
    responses:
Lines 46-51 Link Here
46
    x-koha-authorization:
56
    x-koha-authorization:
47
      permissions:
57
      permissions:
48
        erm: 1
58
        erm: 1
49
    x-koha-embed:
50
      - extended_attributes
51
59
(-)a/api/v1/swagger/paths/items.yaml (-7 / +14 lines)
Lines 221-226 Link Here
221
      - $ref: "../swagger.yaml#/parameters/q_param"
221
      - $ref: "../swagger.yaml#/parameters/q_param"
222
      - $ref: "../swagger.yaml#/parameters/q_body"
222
      - $ref: "../swagger.yaml#/parameters/q_body"
223
      - $ref: "../swagger.yaml#/parameters/q_header"
223
      - $ref: "../swagger.yaml#/parameters/q_header"
224
      - name: x-koha-embed
225
        in: header
226
        required: false
227
        description: Embed list sent as a request header
228
        type: array
229
        items:
230
          type: string
231
          enum:
232
            - biblio
233
            - checkout
234
            - return_claims
235
            - return_claim
236
            - return_claim.patron
237
        collectionFormat: csv
224
    consumes:
238
    consumes:
225
      - application/json
239
      - application/json
226
    produces:
240
    produces:
Lines 251-262 Link Here
251
    x-koha-authorization:
265
    x-koha-authorization:
252
      permissions:
266
      permissions:
253
        catalogue: "1"
267
        catalogue: "1"
254
    x-koha-embed:
255
      - biblio
256
      - checkout
257
      - return_claims
258
      - return_claim
259
      - return_claim.patron
260
"/items/{item_id}/bundled_items/{bundled_item_id}":
268
"/items/{item_id}/bundled_items/{bundled_item_id}":
261
  delete:
269
  delete:
262
    x-mojo-to: Items#remove_from_bundle
270
    x-mojo-to: Items#remove_from_bundle
263
- 

Return to bug 32923