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

(-)a/api/v1/swagger/definitions.yaml (-63 lines)
Lines 1-63 Link Here
1
---
2
account_line:
3
  $ref: definitions/account_line.yaml
4
advancededitormacro:
5
  $ref: definitions/advancededitormacro.yaml
6
allows_renewal:
7
  $ref: definitions/allows_renewal.yaml
8
basket:
9
  $ref: definitions/basket.yaml
10
cashup:
11
  $ref: definitions/cashup.yaml
12
checkout:
13
  $ref: definitions/checkout.yaml
14
checkouts:
15
  $ref: definitions/checkouts.yaml
16
circ-rule-kind:
17
  $ref: definitions/circ-rule-kind.yaml
18
city:
19
  $ref: definitions/city.yaml
20
error:
21
  $ref: definitions/error.yaml
22
fund:
23
  $ref: definitions/fund.yaml
24
hold:
25
  $ref: definitions/hold.yaml
26
holds:
27
  $ref: definitions/holds.yaml
28
ill_backend:
29
  $ref: definitions/ill_backend.yaml
30
ill_backends:
31
  $ref: definitions/ill_backends.yaml
32
import_batch_profile:
33
  $ref: definitions/import_batch_profile.yaml
34
import_batch_profiles:
35
  $ref: definitions/import_batch_profiles.yaml
36
invoice:
37
  $ref: definitions/invoice.yaml
38
item:
39
  $ref: definitions/item.yaml
40
library:
41
  $ref: definitions/library.yaml
42
order:
43
  $ref: definitions/order.yaml
44
patron:
45
  $ref: definitions/patron.yaml
46
patron_account_credit:
47
  $ref: definitions/patron_account_credit.yaml
48
patron_balance:
49
  $ref: definitions/patron_balance.yaml
50
patron_extended_attribute:
51
  $ref: definitions/patron_extended_attribute.yaml
52
quote:
53
  $ref: definitions/quote.yaml
54
return_claim:
55
  $ref: definitions/return_claim.yaml
56
smtp_server:
57
  $ref: definitions/smtp_server.yaml
58
suggestion:
59
  $ref: definitions/suggestion.yaml
60
transfer_limit:
61
  $ref: definitions/transfer_limit.yaml
62
vendor:
63
  $ref: definitions/vendor.yaml
(-)a/api/v1/swagger/definitions/advancededitormacro.yaml (-1 / +3 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  macro_id:
4
  macro_id:
5
    $ref: ../x-primitives.yaml#/advancededitormacro_id
5
    type: integer
6
    description: Internal advanced editor macro identifier
7
    readOnly: true
6
  name:
8
  name:
7
    description: macro name
9
    description: macro name
8
    type: string
10
    type: string
(-)a/api/v1/swagger/definitions/checkout.yaml (-1 / +2 lines)
Lines 5-11 properties: Link Here
5
    type: integer
5
    type: integer
6
    description: internally assigned checkout identifier
6
    description: internally assigned checkout identifier
7
  patron_id:
7
  patron_id:
8
    $ref: ../x-primitives.yaml#/patron_id
8
    type: integer
9
    description: Internal patron identifier
9
  item_id:
10
  item_id:
10
    type: integer
11
    type: integer
11
    description: internal identifier of checked out item
12
    description: internal identifier of checked out item
(-)a/api/v1/swagger/definitions/checkouts.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: checkout.yaml
4
  $ref: "checkout.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/city.yaml (-1 / +3 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  city_id:
4
  city_id:
5
    $ref: ../x-primitives.yaml#/city_id
5
    type: integer
6
    description: internally assigned city identifier
7
    readOnly: true
6
  name:
8
  name:
7
    description: city name
9
    description: city name
8
    type: string
10
    type: string
(-)a/api/v1/swagger/definitions/club_hold_patron_holds.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: club_hold_patron_hold.yaml
4
  $ref: "club_hold_patron_hold.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/club_holds.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: club_hold.yaml
4
  $ref: "club_hold.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/fund.yaml (-1 / +3 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  fund_id:
4
  fund_id:
5
    $ref: ../x-primitives.yaml#/fund_id
5
    type: integer
6
    description: internally assigned fund identifier
7
    readOnly: true
6
  code:
8
  code:
7
    type:
9
    type:
8
      - string
10
      - string
(-)a/api/v1/swagger/definitions/holds.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: hold.yaml
4
  $ref: "hold.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/ill_backends.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: ill_backend.yaml
4
  $ref: "ill_backend.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/import_batch_profiles.yaml (-1 / +1 lines)
Lines 1-5 Link Here
1
---
1
---
2
type: array
2
type: array
3
items:
3
items:
4
  $ref: import_batch_profile.yaml
4
  $ref: "import_batch_profile.yaml"
5
additionalProperties: false
5
additionalProperties: false
(-)a/api/v1/swagger/definitions/library.yaml (-1 / +4 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  library_id:
4
  library_id:
5
    $ref: ../x-primitives.yaml#/library_id
5
    type: string
6
    description: internally assigned library identifier
7
    maxLength: 10
8
    minLength: 1
6
  name:
9
  name:
7
    type: string
10
    type: string
8
    description: Printable name of library
11
    description: Printable name of library
(-)a/api/v1/swagger/definitions/patron.yaml (-7 / +23 lines)
Lines 2-14 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  patron_id:
4
  patron_id:
5
    $ref: ../x-primitives.yaml#/patron_id
5
    type: integer
6
    description: Internal patron identifier
6
  cardnumber:
7
  cardnumber:
7
    $ref: ../x-primitives.yaml#/cardnumber
8
    type:
9
      - string
10
      - "null"
11
    description: library assigned user identifier
8
  surname:
12
  surname:
9
    $ref: ../x-primitives.yaml#/surname
13
    type:
14
      - string
15
      - "null"
16
    description: patron's last name
10
  firstname:
17
  firstname:
11
    $ref: ../x-primitives.yaml#/firstname
18
    type:
19
      - string
20
      - "null"
21
    description: patron's first name
12
  title:
22
  title:
13
    type:
23
    type:
14
      - string
24
      - string
Lines 65-73 properties: Link Here
65
      - "null"
75
      - "null"
66
    description: country of patron's primary address
76
    description: country of patron's primary address
67
  email:
77
  email:
68
    $ref: ../x-primitives.yaml#/email
78
    type:
79
      - string
80
      - "null"
81
    description: primary email address for patron's primary address
69
  phone:
82
  phone:
70
    $ref: ../x-primitives.yaml#/phone
83
    type:
84
      - string
85
      - "null"
86
    description: primary phone number for patron's primary address
71
  mobile:
87
  mobile:
72
    type:
88
    type:
73
      - string
89
      - string
Lines 327-333 properties: Link Here
327
    type: array
343
    type: array
328
    description: patron's extended attributes
344
    description: patron's extended attributes
329
    items:
345
    items:
330
      $ref: patron_extended_attribute.yaml
346
      $ref: "patron_extended_attribute.yaml"
331
additionalProperties: false
347
additionalProperties: false
332
required:
348
required:
333
  - surname
349
  - surname
(-)a/api/v1/swagger/definitions/patron_balance.yaml (-2 / +2 lines)
Lines 11-17 properties: Link Here
11
      lines:
11
      lines:
12
        type: array
12
        type: array
13
        items:
13
        items:
14
          $ref: account_line.yaml
14
          $ref: "account_line.yaml"
15
  outstanding_debits:
15
  outstanding_debits:
16
    type: object
16
    type: object
17
    properties:
17
    properties:
Lines 20-26 properties: Link Here
20
      lines:
20
      lines:
21
        type: array
21
        type: array
22
        items:
22
        items:
23
          $ref: account_line.yaml
23
          $ref: "account_line.yaml"
24
additionalProperties: false
24
additionalProperties: false
25
required:
25
required:
26
  - balance
26
  - balance
(-)a/api/v1/swagger/definitions/quote.yaml (-1 / +2 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  quote_id:
4
  quote_id:
5
    $ref: ../x-primitives.yaml#/quote_id
5
    type: integer
6
    description: internally assigned quote identifier
6
  source:
7
  source:
7
    description: source of the quote
8
    description: source of the quote
8
    type: string
9
    type: string
(-)a/api/v1/swagger/definitions/return_claim.yaml (-1 / +2 lines)
Lines 20-26 properties: Link Here
20
      - "null"
20
      - "null"
21
    description: internal identifier of the claimed checkout if not longer checked out
21
    description: internal identifier of the claimed checkout if not longer checked out
22
  patron_id:
22
  patron_id:
23
    $ref: ../x-primitives.yaml#/patron_id
23
    type: integer
24
    description: Internal patron identifier
24
  notes:
25
  notes:
25
    type:
26
    type:
26
      - string
27
      - string
(-)a/api/v1/swagger/definitions/vendor.yaml (-1 / +3 lines)
Lines 2-8 Link Here
2
type: object
2
type: object
3
properties:
3
properties:
4
  id:
4
  id:
5
    $ref: ../x-primitives.yaml#/vendor_id
5
    type: integer
6
    description: internally assigned vendor identifier
7
    readOnly: true
6
  name:
8
  name:
7
    type:
9
    type:
8
      - string
10
      - string
(-)a/api/v1/swagger/parameters.yaml (-97 lines)
Lines 1-97 Link Here
1
---
2
advancededitormacro_id_pp:
3
  $ref: parameters/advancededitormacro.yaml#/advancededitormacro_id_pp
4
biblio_id_pp:
5
  $ref: parameters/biblio.yaml#/biblio_id_pp
6
cash_register_id_pp:
7
  $ref: parameters/cash_register.yaml#/cash_register_id_pp
8
cashup_id_pp:
9
  $ref: parameters/cashup.yaml#/cashup_id_pp
10
checkout_id_pp:
11
  $ref: parameters/checkout.yaml#/checkout_id_pp
12
city_id_pp:
13
  $ref: parameters/city.yaml#/city_id_pp
14
club_id_pp:
15
  $ref: parameters/club.yaml#/club_id_pp
16
fund_id_pp:
17
  $ref: parameters/fund.yaml#/fund_id_pp
18
hold_id_pp:
19
  $ref: parameters/hold.yaml#/hold_id_pp
20
import_batch_profile_id_pp:
21
  $ref: parameters/import_batch_profile.yaml#/import_batch_profile_id_pp
22
item_id_pp:
23
  $ref: parameters/item.yaml#/item_id_pp
24
library_id_pp:
25
  $ref: parameters/library.yaml#/library_id_pp
26
match:
27
  name: _match
28
  in: query
29
  required: false
30
  description: Matching criteria
31
  type: string
32
  enum:
33
    - contains
34
    - exact
35
    - starts_with
36
    - ends_with
37
order_by:
38
  name: _order_by
39
  in: query
40
  required: false
41
  description: Sorting criteria
42
  type: array
43
  collectionFormat: csv
44
  items:
45
    type: string
46
order_id_pp:
47
  $ref: parameters/order.yaml#/order_id_pp
48
page:
49
  name: _page
50
  in: query
51
  required: false
52
  description: Page number, for paginated object listing
53
  type: integer
54
patron_id_pp:
55
  $ref: parameters/patron.yaml#/patron_id_pp
56
patron_id_qp:
57
  $ref: parameters/patron.yaml#/patron_id_qp
58
per_page:
59
  name: _per_page
60
  in: query
61
  required: false
62
  description: Page size, for paginated object listing
63
  type: integer
64
q_body:
65
  name: query
66
  in: body
67
  required: false
68
  description: Query filter sent through request's body
69
  schema:
70
    type: object
71
q_param:
72
  name: q
73
  in: query
74
  required: false
75
  description: Query filter sent as a request parameter
76
  type: array
77
  items:
78
    type: string
79
  collectionFormat: multi
80
q_header:
81
  name: x-koha-query
82
  in: header
83
  required: false
84
  description: Query filter sent as a request header
85
  type: string
86
quote_id_pp:
87
  $ref: parameters/quote.yaml#/quote_id_pp
88
seen_pp:
89
  $ref: parameters/checkout.yaml#/seen_pp
90
smtp_server_id_pp:
91
  $ref: parameters/smtp_server.yaml#/smtp_server_id_pp
92
suggestion_id_pp:
93
  $ref: parameters/suggestion.yaml#/suggestion_id_pp
94
transfer_limit_id_pp:
95
  $ref: parameters/transfer_limit.yaml#/transfer_limit_id_pp
96
vendor_id_pp:
97
  $ref: parameters/vendor.yaml#/vendor_id_pp
(-)a/api/v1/swagger/parameters/advancededitormacro.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
advancededitormacro_id_pp:
3
  name: advancededitormacro_id
4
  in: path
5
  description: Advanced editor macro internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/biblio.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
biblio_id_pp:
3
  name: biblio_id
4
  in: path
5
  description: Record internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/cash_register.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
cash_register_id_pp:
3
  name: cash_register_id
4
  in: path
5
  description: Cash register internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/cashup.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
cashup_id_pp:
3
  name: cashup_id
4
  in: path
5
  description: Cashup internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/checkout.yaml (-13 lines)
Lines 1-13 Link Here
1
---
2
checkout_id_pp:
3
  name: checkout_id
4
  in: path
5
  description: Internal checkout identifier
6
  required: true
7
  type: integer
8
seen_pp:
9
  name: seen
10
  in: query
11
  description: Item was seen flag
12
  required: false
13
  type: integer
(-)a/api/v1/swagger/parameters/city.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
city_id_pp:
3
  name: city_id
4
  in: path
5
  description: City internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/club.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
club_id_pp:
3
  name: club_id
4
  in: path
5
  description: Internal club identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/fund.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
fund_id_pp:
3
  name: fund_id
4
  in: path
5
  description: Fund id
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/hold.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
hold_id_pp:
3
  name: hold_id
4
  in: path
5
  description: Internal hold identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/import_batch_profile.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
import_batch_profile_id_pp:
3
  name: import_batch_profile_id
4
  in: path
5
  description: Internal profile identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/item.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
item_id_pp:
3
  name: item_id
4
  in: path
5
  description: Internal item identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/library.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
library_id_pp:
3
  name: library_id
4
  in: path
5
  description: Internal library identifier
6
  required: true
7
  type: string
(-)a/api/v1/swagger/parameters/order.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
order_id_pp:
3
  name: order_id
4
  in: path
5
  description: Internal order identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/patron.yaml (-12 lines)
Lines 1-12 Link Here
1
---
2
patron_id_pp:
3
  name: patron_id
4
  in: path
5
  description: Internal patron identifier
6
  required: true
7
  type: integer
8
patron_id_qp:
9
  name: patron_id
10
  in: query
11
  description: Internal patron identifier
12
  type: integer
(-)a/api/v1/swagger/parameters/quote.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
quote_id_pp:
3
  name: quote_id
4
  in: path
5
  description: Quote internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/smtp_server.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
smtp_server_id_pp:
3
  name: smtp_server_id
4
  in: path
5
  description: SMTP server internal identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/suggestion.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
suggestion_id_pp:
3
  name: suggestion_id
4
  in: path
5
  description: Internal suggestion identifier
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/parameters/transfer_limit.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
transfer_limit_id_pp:
3
  name: limit_id
4
  in: path
5
  description: Internal transfer limit identifier
6
  required: true
7
  type: string
(-)a/api/v1/swagger/parameters/vendor.yaml (-7 lines)
Lines 1-7 Link Here
1
---
2
vendor_id_pp:
3
  name: vendor_id
4
  in: path
5
  description: Vendor id
6
  required: true
7
  type: integer
(-)a/api/v1/swagger/paths.yaml (-143 lines)
Lines 1-143 Link Here
1
---
2
/oauth/token:
3
  $ref: paths/oauth.yaml#/~1oauth~1token
4
/acquisitions/orders:
5
  $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders
6
"/acquisitions/orders/{order_id}":
7
  $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}
8
/acquisitions/vendors:
9
  $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
10
"/acquisitions/vendors/{vendor_id}":
11
  $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}
12
/acquisitions/funds:
13
  $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds
14
"/article_requests/{article_request_id}":
15
  $ref: paths/article_requests.yaml#/~1article_requests~1{article_request_id}
16
"/biblios/{biblio_id}":
17
  $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}
18
"/biblios/{biblio_id}/checkouts":
19
  $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts
20
"/biblios/{biblio_id}/items":
21
  $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1items
22
"/biblios/{biblio_id}/pickup_locations":
23
  $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations
24
"/cash_registers/{cash_register_id}/cashups":
25
  $ref: paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups
26
"/cashups/{cashup_id}":
27
  $ref: paths/cash_registers.yaml#/~1cashups~1{cashup_id}
28
/checkouts:
29
  $ref: paths/checkouts.yaml#/~1checkouts
30
"/checkouts/{checkout_id}":
31
  $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id}
32
"/checkouts/{checkout_id}/renewal":
33
  $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal
34
/circulation-rules/kinds:
35
  $ref: paths/circulation-rules.yaml#/~1circulation-rules~1kinds
36
/cities:
37
  $ref: paths/cities.yaml#/~1cities
38
"/cities/{city_id}":
39
  $ref: paths/cities.yaml#/~1cities~1{city_id}
40
"/clubs/{club_id}/holds":
41
  $ref: paths/clubs.yaml#/~1clubs~1{club_id}~1holds
42
/config/smtp_servers:
43
  $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers
44
"/config/smtp_servers/{smtp_server_id}":
45
  $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}
46
/holds:
47
  $ref: paths/holds.yaml#/~1holds
48
"/holds/{hold_id}":
49
  $ref: paths/holds.yaml#/~1holds~1{hold_id}
50
"/holds/{hold_id}/priority":
51
  $ref: paths/holds.yaml#/~1holds~1{hold_id}~1priority
52
"/holds/{hold_id}/suspension":
53
  $ref: paths/holds.yaml#/~1holds~1{hold_id}~1suspension
54
"/holds/{hold_id}/pickup_locations":
55
  $ref: paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations
56
"/holds/{hold_id}/pickup_location":
57
  $ref: paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location
58
/items:
59
  $ref: paths/items.yaml#/~1items
60
"/items/{item_id}":
61
  $ref: paths/items.yaml#/~1items~1{item_id}
62
"/items/{item_id}/pickup_locations":
63
  $ref: paths/items.yaml#/~1items~1{item_id}~1pickup_locations
64
/libraries:
65
  $ref: paths/libraries.yaml#/~1libraries
66
"/libraries/{library_id}":
67
  $ref: paths/libraries.yaml#/~1libraries~1{library_id}
68
/transfer_limits:
69
  $ref: paths/transfer_limits.yaml#/~1transfer_limits
70
"/transfer_limits/{limit_id}":
71
  $ref: paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}
72
/transfer_limits/batch:
73
  $ref: paths/transfer_limits.yaml#/~1transfer_limits~1batch
74
"/checkouts/{checkout_id}/allows_renewal":
75
  $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal
76
/advanced_editor/macros:
77
  $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros
78
"/advanced_editor/macros/{advancededitormacro_id}":
79
  $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}
80
/advanced_editor/macros/shared:
81
  $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared
82
"/advanced_editor/macros/shared/{advancededitormacro_id}":
83
  $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}
84
/patrons:
85
  $ref: paths/patrons.yaml#/~1patrons
86
"/patrons/{patron_id}":
87
  $ref: paths/patrons.yaml#/~1patrons~1{patron_id}
88
"/patrons/{patron_id}/account":
89
  $ref: paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account
90
"/patrons/{patron_id}/account/credits":
91
  $ref: paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits
92
"/patrons/{patron_id}/extended_attributes":
93
  $ref: paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes
94
"/patrons/{patron_id}/extended_attributes/{extended_attribute_id}":
95
  $ref: paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}
96
"/patrons/{patron_id}/holds":
97
  $ref: paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds
98
"/patrons/{patron_id}/password":
99
  $ref: paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password
100
/ill_backends:
101
  $ref: paths/ill_backends.yaml#/~1ill_backends
102
"/ill_backends/{ill_backend_id}":
103
  $ref: paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id}
104
/illrequests:
105
  $ref: paths/illrequests.yaml#/~1illrequests
106
/import_batch_profiles:
107
  $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles
108
"/import_batch_profiles/{import_batch_profile_id}":
109
  $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}
110
"/rotas/{rota_id}/stages/{stage_id}/position":
111
  $ref: paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position
112
"/public/biblios/{biblio_id}":
113
  $ref: paths/biblios.yaml#/~1public~1biblios~1{biblio_id}
114
"/public/biblios/{biblio_id}/items":
115
  $ref: paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items
116
/public/libraries:
117
  $ref: paths/libraries.yaml#/~1public~1libraries
118
"/public/libraries/{library_id}":
119
  $ref: paths/libraries.yaml#/~1public~1libraries~1{library_id}
120
"/public/patrons/{patron_id}/article_requests/{article_request_id}":
121
  $ref: paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}
122
"/public/patrons/{patron_id}/password":
123
  $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password
124
"/public/patrons/{patron_id}/guarantors/can_see_charges":
125
  $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges
126
"/public/patrons/{patron_id}/guarantors/can_see_checkouts":
127
  $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts
128
/quotes:
129
  $ref: paths/quotes.yaml#/~1quotes
130
"/quotes/{quote_id}":
131
  $ref: paths/quotes.yaml#/~1quotes~1{quote_id}
132
/return_claims:
133
  $ref: paths/return_claims.yaml#/~1return_claims
134
"/return_claims/{claim_id}/notes":
135
  $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes
136
"/return_claims/{claim_id}/resolve":
137
  $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve
138
"/return_claims/{claim_id}":
139
  $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id}
140
/suggestions:
141
  $ref: paths/suggestions.yaml#/~1suggestions
142
"/suggestions/{suggestion_id}":
143
  $ref: paths/suggestions.yaml#/~1suggestions~1{suggestion_id}
(-)a/api/v1/swagger/paths/acquisitions_funds.yaml (-14 / +14 lines)
Lines 19-61 Link Here
19
        description: Display only the funds that belongs to the given patron ID
19
        description: Display only the funds that belongs to the given patron ID
20
        required: false
20
        required: false
21
        type: integer
21
        type: integer
22
      - $ref: ../parameters.yaml#/match
22
      - $ref: "../swagger.yaml#/parameters/match"
23
      - $ref: ../parameters.yaml#/order_by
23
      - $ref: "../swagger.yaml#/parameters/order_by"
24
      - $ref: ../parameters.yaml#/page
24
      - $ref: "../swagger.yaml#/parameters/page"
25
      - $ref: ../parameters.yaml#/per_page
25
      - $ref: "../swagger.yaml#/parameters/per_page"
26
      - $ref: ../parameters.yaml#/q_param
26
      - $ref: "../swagger.yaml#/parameters/q_param"
27
      - $ref: ../parameters.yaml#/q_body
27
      - $ref: "../swagger.yaml#/parameters/q_body"
28
      - $ref: ../parameters.yaml#/q_header
28
      - $ref: "../swagger.yaml#/parameters/q_header"
29
    responses:
29
    responses:
30
      "200":
30
      "200":
31
        description: A list of funds
31
        description: A list of funds
32
        schema:
32
        schema:
33
          type: array
33
          type: array
34
          items:
34
          items:
35
            $ref: ../definitions.yaml#/fund
35
            $ref: "../swagger.yaml#/definitions/fund"
36
      "401":
36
      "401":
37
        description: Authentication required
37
        description: Authentication required
38
        schema:
38
        schema:
39
          $ref: ../definitions.yaml#/error
39
          $ref: "../swagger.yaml#/definitions/error"
40
      "403":
40
      "403":
41
        description: Access forbidden
41
        description: Access forbidden
42
        schema:
42
        schema:
43
          $ref: ../definitions.yaml#/error
43
          $ref: "../swagger.yaml#/definitions/error"
44
      "404":
44
      "404":
45
        description: Fund not found
45
        description: Fund not found
46
        schema:
46
        schema:
47
          $ref: ../definitions.yaml#/error
47
          $ref: "../swagger.yaml#/definitions/error"
48
      "500":
48
      "500":
49
        description: |
49
        description: |
50
          Internal server error. Possible `error_code` attribute values:
50
          Internal server error. Possible `error_code` attribute values:
51
51
  
52
          * `internal_server_error`
52
          * `internal_server_error`
53
        schema:
53
        schema:
54
          $ref: ../definitions.yaml#/error
54
          $ref: "../swagger.yaml#/definitions/error"
55
      "503":
55
      "503":
56
        description: Under maintenance
56
        description: Under maintenance
57
        schema:
57
        schema:
58
          $ref: ../definitions.yaml#/error
58
          $ref: "../swagger.yaml#/definitions/error"
59
    x-koha-authorization:
59
    x-koha-authorization:
60
      permissions:
60
      permissions:
61
        acquisition: budget_manage_all
61
        acquisition: budget_manage_all
(-)a/api/v1/swagger/paths/acquisitions_orders.yaml (-42 / +42 lines)
Lines 35-77 Link Here
35
        description: If only active orders should be listed
35
        description: If only active orders should be listed
36
        required: false
36
        required: false
37
        type: boolean
37
        type: boolean
38
      - $ref: ../parameters.yaml#/match
38
      - $ref: "../swagger.yaml#/parameters/match"
39
      - $ref: ../parameters.yaml#/order_by
39
      - $ref: "../swagger.yaml#/parameters/order_by"
40
      - $ref: ../parameters.yaml#/page
40
      - $ref: "../swagger.yaml#/parameters/page"
41
      - $ref: ../parameters.yaml#/per_page
41
      - $ref: "../swagger.yaml#/parameters/per_page"
42
      - $ref: ../parameters.yaml#/q_param
42
      - $ref: "../swagger.yaml#/parameters/q_param"
43
      - $ref: ../parameters.yaml#/q_body
43
      - $ref: "../swagger.yaml#/parameters/q_body"
44
      - $ref: ../parameters.yaml#/q_header
44
      - $ref: "../swagger.yaml#/parameters/q_header"
45
    responses:
45
    responses:
46
      "200":
46
      "200":
47
        description: A list of orders
47
        description: A list of orders
48
        schema:
48
        schema:
49
          type: array
49
          type: array
50
          items:
50
          items:
51
            $ref: ../definitions.yaml#/order
51
            $ref: "../swagger.yaml#/definitions/order"
52
      "401":
52
      "401":
53
        description: Authentication required
53
        description: Authentication required
54
        schema:
54
        schema:
55
          $ref: ../definitions.yaml#/error
55
          $ref: "../swagger.yaml#/definitions/error"
56
      "403":
56
      "403":
57
        description: Access forbidden
57
        description: Access forbidden
58
        schema:
58
        schema:
59
          $ref: ../definitions.yaml#/error
59
          $ref: "../swagger.yaml#/definitions/error"
60
      "404":
60
      "404":
61
        description: Order not found
61
        description: Order not found
62
        schema:
62
        schema:
63
          $ref: ../definitions.yaml#/error
63
          $ref: "../swagger.yaml#/definitions/error"
64
      "500":
64
      "500":
65
        description: |
65
        description: |
66
          Internal server error. Possible `error_code` attribute values:
66
          Internal server error. Possible `error_code` attribute values:
67
67
68
          * `internal_server_error`
68
          * `internal_server_error`
69
        schema:
69
        schema:
70
          $ref: ../definitions.yaml#/error
70
          $ref: "../swagger.yaml#/definitions/error"
71
      "503":
71
      "503":
72
        description: Under maintenance
72
        description: Under maintenance
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/error
74
          $ref: "../swagger.yaml#/definitions/error"
75
    x-koha-authorization:
75
    x-koha-authorization:
76
      permissions:
76
      permissions:
77
        acquisition:
77
        acquisition:
Lines 103-143 Link Here
103
        description: A JSON object representing an order
103
        description: A JSON object representing an order
104
        required: true
104
        required: true
105
        schema:
105
        schema:
106
          $ref: ../definitions.yaml#/order
106
          $ref: "../swagger.yaml#/definitions/order"
107
    produces:
107
    produces:
108
      - application/json
108
      - application/json
109
    responses:
109
    responses:
110
      "201":
110
      "201":
111
        description: Order added
111
        description: Order added
112
        schema:
112
        schema:
113
          $ref: ../definitions.yaml#/order
113
          $ref: "../swagger.yaml#/definitions/order"
114
      "400":
114
      "400":
115
        description: Bad request
115
        description: Bad request
116
        schema:
116
        schema:
117
          $ref: ../definitions.yaml#/error
117
          $ref: "../swagger.yaml#/definitions/error"
118
      "401":
118
      "401":
119
        description: Authentication required
119
        description: Authentication required
120
        schema:
120
        schema:
121
          $ref: ../definitions.yaml#/error
121
          $ref: "../swagger.yaml#/definitions/error"
122
      "403":
122
      "403":
123
        description: Access forbidden
123
        description: Access forbidden
124
        schema:
124
        schema:
125
          $ref: ../definitions.yaml#/error
125
          $ref: "../swagger.yaml#/definitions/error"
126
      "409":
126
      "409":
127
        description: Conflict in creating the resource
127
        description: Conflict in creating the resource
128
        schema:
128
        schema:
129
          $ref: ../definitions.yaml#/error
129
          $ref: "../swagger.yaml#/definitions/error"
130
      "500":
130
      "500":
131
        description: |
131
        description: |
132
          Internal server error. Possible `error_code` attribute values:
132
          Internal server error. Possible `error_code` attribute values:
133
133
134
          * `internal_server_error`
134
          * `internal_server_error`
135
        schema:
135
        schema:
136
          $ref: ../definitions.yaml#/error
136
          $ref: "../swagger.yaml#/definitions/error"
137
      "503":
137
      "503":
138
        description: Under maintenance
138
        description: Under maintenance
139
        schema:
139
        schema:
140
          $ref: ../definitions.yaml#/error
140
          $ref: "../swagger.yaml#/definitions/error"
141
    x-koha-authorization:
141
    x-koha-authorization:
142
      permissions:
142
      permissions:
143
        acquisition: order_manage
143
        acquisition: order_manage
Lines 149-185 Link Here
149
      - orders
149
      - orders
150
    summary: Get order
150
    summary: Get order
151
    parameters:
151
    parameters:
152
      - $ref: ../parameters.yaml#/order_id_pp
152
      - $ref: "../swagger.yaml#/parameters/order_id_pp"
153
    produces:
153
    produces:
154
      - application/json
154
      - application/json
155
    responses:
155
    responses:
156
      "200":
156
      "200":
157
        description: An order
157
        description: An order
158
        schema:
158
        schema:
159
          $ref: ../definitions.yaml#/order
159
          $ref: "../swagger.yaml#/definitions/order"
160
      "401":
160
      "401":
161
        description: Authentication required
161
        description: Authentication required
162
        schema:
162
        schema:
163
          $ref: ../definitions.yaml#/error
163
          $ref: "../swagger.yaml#/definitions/error"
164
      "403":
164
      "403":
165
        description: Access forbidden
165
        description: Access forbidden
166
        schema:
166
        schema:
167
          $ref: ../definitions.yaml#/error
167
          $ref: "../swagger.yaml#/definitions/error"
168
      "404":
168
      "404":
169
        description: Order not found
169
        description: Order not found
170
        schema:
170
        schema:
171
          $ref: ../definitions.yaml#/error
171
          $ref: "../swagger.yaml#/definitions/error"
172
      "500":
172
      "500":
173
        description: |
173
        description: |
174
          Internal server error. Possible `error_code` attribute values:
174
          Internal server error. Possible `error_code` attribute values:
175
175
176
          * `internal_server_error`
176
          * `internal_server_error`
177
        schema:
177
        schema:
178
          $ref: ../definitions.yaml#/error
178
          $ref: "../swagger.yaml#/definitions/error"
179
      "503":
179
      "503":
180
        description: Under maintenance
180
        description: Under maintenance
181
        schema:
181
        schema:
182
          $ref: ../definitions.yaml#/error
182
          $ref: "../swagger.yaml#/definitions/error"
183
    x-koha-authorization:
183
    x-koha-authorization:
184
      permissions:
184
      permissions:
185
        acquisition: order_manage
185
        acquisition: order_manage
Lines 204-246 Link Here
204
      - orders
204
      - orders
205
    summary: Update order
205
    summary: Update order
206
    parameters:
206
    parameters:
207
      - $ref: ../parameters.yaml#/order_id_pp
207
      - $ref: "../swagger.yaml#/parameters/order_id_pp"
208
      - name: body
208
      - name: body
209
        in: body
209
        in: body
210
        description: A JSON object representing an order
210
        description: A JSON object representing an order
211
        required: true
211
        required: true
212
        schema:
212
        schema:
213
          $ref: ../definitions.yaml#/order
213
          $ref: "../swagger.yaml#/definitions/order"
214
    produces:
214
    produces:
215
      - application/json
215
      - application/json
216
    responses:
216
    responses:
217
      "200":
217
      "200":
218
        description: An order
218
        description: An order
219
        schema:
219
        schema:
220
          $ref: ../definitions.yaml#/order
220
          $ref: "../swagger.yaml#/definitions/order"
221
      "401":
221
      "401":
222
        description: Authentication required
222
        description: Authentication required
223
        schema:
223
        schema:
224
          $ref: ../definitions.yaml#/error
224
          $ref: "../swagger.yaml#/definitions/error"
225
      "403":
225
      "403":
226
        description: Access forbidden
226
        description: Access forbidden
227
        schema:
227
        schema:
228
          $ref: ../definitions.yaml#/error
228
          $ref: "../swagger.yaml#/definitions/error"
229
      "404":
229
      "404":
230
        description: Order not found
230
        description: Order not found
231
        schema:
231
        schema:
232
          $ref: ../definitions.yaml#/error
232
          $ref: "../swagger.yaml#/definitions/error"
233
      "500":
233
      "500":
234
        description: |
234
        description: |
235
          Internal server error. Possible `error_code` attribute values:
235
          Internal server error. Possible `error_code` attribute values:
236
236
237
          * `internal_server_error`
237
          * `internal_server_error`
238
        schema:
238
        schema:
239
          $ref: ../definitions.yaml#/error
239
          $ref: "../swagger.yaml#/definitions/error"
240
      "503":
240
      "503":
241
        description: Under maintenance
241
        description: Under maintenance
242
        schema:
242
        schema:
243
          $ref: ../definitions.yaml#/error
243
          $ref: "../swagger.yaml#/definitions/error"
244
    x-koha-authorization:
244
    x-koha-authorization:
245
      permissions:
245
      permissions:
246
        acquisition: order_manage
246
        acquisition: order_manage
Lines 251-257 Link Here
251
      - orders
251
      - orders
252
    summary: Delete order
252
    summary: Delete order
253
    parameters:
253
    parameters:
254
      - $ref: ../parameters.yaml#/order_id_pp
254
      - $ref: "../swagger.yaml#/parameters/order_id_pp"
255
    produces:
255
    produces:
256
      - application/json
256
      - application/json
257
    responses:
257
    responses:
Lines 260-285 Link Here
260
      "401":
260
      "401":
261
        description: Authentication required
261
        description: Authentication required
262
        schema:
262
        schema:
263
          $ref: ../definitions.yaml#/error
263
          $ref: "../swagger.yaml#/definitions/error"
264
      "403":
264
      "403":
265
        description: Access forbidden
265
        description: Access forbidden
266
        schema:
266
        schema:
267
          $ref: ../definitions.yaml#/error
267
          $ref: "../swagger.yaml#/definitions/error"
268
      "404":
268
      "404":
269
        description: Order not found
269
        description: Order not found
270
        schema:
270
        schema:
271
          $ref: ../definitions.yaml#/error
271
          $ref: "../swagger.yaml#/definitions/error"
272
      "500":
272
      "500":
273
        description: |
273
        description: |
274
          Internal server error. Possible `error_code` attribute values:
274
          Internal server error. Possible `error_code` attribute values:
275
275
276
          * `internal_server_error`
276
          * `internal_server_error`
277
        schema:
277
        schema:
278
          $ref: ../definitions.yaml#/error
278
          $ref: "../swagger.yaml#/definitions/error"
279
      "503":
279
      "503":
280
        description: Under maintenance
280
        description: Under maintenance
281
        schema:
281
        schema:
282
          $ref: ../definitions.yaml#/error
282
          $ref: "../swagger.yaml#/definitions/error"
283
    x-koha-authorization:
283
    x-koha-authorization:
284
      permissions:
284
      permissions:
285
        acquisition: order_manage
285
        acquisition: order_manage
(-)a/api/v1/swagger/paths/acquisitions_vendors.yaml (-41 / +41 lines)
Lines 19-61 Link Here
19
        description: Case insensitive search on vendor's account number
19
        description: Case insensitive search on vendor's account number
20
        required: false
20
        required: false
21
        type: string
21
        type: string
22
      - $ref: ../parameters.yaml#/match
22
      - $ref: "../swagger.yaml#/parameters/match"
23
      - $ref: ../parameters.yaml#/order_by
23
      - $ref: "../swagger.yaml#/parameters/order_by"
24
      - $ref: ../parameters.yaml#/page
24
      - $ref: "../swagger.yaml#/parameters/page"
25
      - $ref: ../parameters.yaml#/per_page
25
      - $ref: "../swagger.yaml#/parameters/per_page"
26
      - $ref: ../parameters.yaml#/q_param
26
      - $ref: "../swagger.yaml#/parameters/q_param"
27
      - $ref: ../parameters.yaml#/q_body
27
      - $ref: "../swagger.yaml#/parameters/q_body"
28
      - $ref: ../parameters.yaml#/q_header
28
      - $ref: "../swagger.yaml#/parameters/q_header"
29
    responses:
29
    responses:
30
      "200":
30
      "200":
31
        description: A list of vendors
31
        description: A list of vendors
32
        schema:
32
        schema:
33
          type: array
33
          type: array
34
          items:
34
          items:
35
            $ref: ../definitions.yaml#/vendor
35
            $ref: "../swagger.yaml#/definitions/vendor"
36
      "401":
36
      "401":
37
        description: Authentication required
37
        description: Authentication required
38
        schema:
38
        schema:
39
          $ref: ../definitions.yaml#/error
39
          $ref: "../swagger.yaml#/definitions/error"
40
      "403":
40
      "403":
41
        description: Access forbidden
41
        description: Access forbidden
42
        schema:
42
        schema:
43
          $ref: ../definitions.yaml#/error
43
          $ref: "../swagger.yaml#/definitions/error"
44
      "404":
44
      "404":
45
        description: Vendor not found
45
        description: Vendor not found
46
        schema:
46
        schema:
47
          $ref: ../definitions.yaml#/error
47
          $ref: "../swagger.yaml#/definitions/error"
48
      "500":
48
      "500":
49
        description: |
49
        description: |
50
          Internal server error. Possible `error_code` attribute values:
50
          Internal server error. Possible `error_code` attribute values:
51
51
52
          * `internal_server_error`
52
          * `internal_server_error`
53
        schema:
53
        schema:
54
          $ref: ../definitions.yaml#/error
54
          $ref: "../swagger.yaml#/definitions/error"
55
      "503":
55
      "503":
56
        description: Under maintenance
56
        description: Under maintenance
57
        schema:
57
        schema:
58
          $ref: ../definitions.yaml#/error
58
          $ref: "../swagger.yaml#/definitions/error"
59
    x-koha-authorization:
59
    x-koha-authorization:
60
      permissions:
60
      permissions:
61
        acquisition: vendors_manage
61
        acquisition: vendors_manage
Lines 71-107 Link Here
71
        description: A JSON object representing a vendor
71
        description: A JSON object representing a vendor
72
        required: true
72
        required: true
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/vendor
74
          $ref: "../swagger.yaml#/definitions/vendor"
75
    produces:
75
    produces:
76
      - application/json
76
      - application/json
77
    responses:
77
    responses:
78
      "201":
78
      "201":
79
        description: Vendor added
79
        description: Vendor added
80
        schema:
80
        schema:
81
          $ref: ../definitions.yaml#/vendor
81
          $ref: "../swagger.yaml#/definitions/vendor"
82
      "401":
82
      "401":
83
        description: Authentication required
83
        description: Authentication required
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
      "403":
86
      "403":
87
        description: Access forbidden
87
        description: Access forbidden
88
        schema:
88
        schema:
89
          $ref: ../definitions.yaml#/error
89
          $ref: "../swagger.yaml#/definitions/error"
90
      "404":
90
      "404":
91
        description: Vendor not found
91
        description: Vendor not found
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/error
93
          $ref: "../swagger.yaml#/definitions/error"
94
      "500":
94
      "500":
95
        description: |
95
        description: |
96
          Internal server error. Possible `error_code` attribute values:
96
          Internal server error. Possible `error_code` attribute values:
97
97
98
          * `internal_server_error`
98
          * `internal_server_error`
99
        schema:
99
        schema:
100
          $ref: ../definitions.yaml#/error
100
          $ref: "../swagger.yaml#/definitions/error"
101
      "503":
101
      "503":
102
        description: Under maintenance
102
        description: Under maintenance
103
        schema:
103
        schema:
104
          $ref: ../definitions.yaml#/error
104
          $ref: "../swagger.yaml#/definitions/error"
105
    x-koha-authorization:
105
    x-koha-authorization:
106
      permissions:
106
      permissions:
107
        acquisition: vendors_manage
107
        acquisition: vendors_manage
Lines 113-149 Link Here
113
      - vendors
113
      - vendors
114
    summary: Get vendor
114
    summary: Get vendor
115
    parameters:
115
    parameters:
116
      - $ref: ../parameters.yaml#/vendor_id_pp
116
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
117
    produces:
117
    produces:
118
      - application/json
118
      - application/json
119
    responses:
119
    responses:
120
      "200":
120
      "200":
121
        description: A vendor
121
        description: A vendor
122
        schema:
122
        schema:
123
          $ref: ../definitions.yaml#/vendor
123
          $ref: "../swagger.yaml#/definitions/vendor"
124
      "401":
124
      "401":
125
        description: Authentication required
125
        description: Authentication required
126
        schema:
126
        schema:
127
          $ref: ../definitions.yaml#/error
127
          $ref: "../swagger.yaml#/definitions/error"
128
      "403":
128
      "403":
129
        description: Access forbidden
129
        description: Access forbidden
130
        schema:
130
        schema:
131
          $ref: ../definitions.yaml#/error
131
          $ref: "../swagger.yaml#/definitions/error"
132
      "404":
132
      "404":
133
        description: Vendor not found
133
        description: Vendor not found
134
        schema:
134
        schema:
135
          $ref: ../definitions.yaml#/error
135
          $ref: "../swagger.yaml#/definitions/error"
136
      "500":
136
      "500":
137
        description: |
137
        description: |
138
          Internal server error. Possible `error_code` attribute values:
138
          Internal server error. Possible `error_code` attribute values:
139
139
140
          * `internal_server_error`
140
          * `internal_server_error`
141
        schema:
141
        schema:
142
          $ref: ../definitions.yaml#/error
142
          $ref: "../swagger.yaml#/definitions/error"
143
      "503":
143
      "503":
144
        description: Under maintenance
144
        description: Under maintenance
145
        schema:
145
        schema:
146
          $ref: ../definitions.yaml#/error
146
          $ref: "../swagger.yaml#/definitions/error"
147
    x-koha-authorization:
147
    x-koha-authorization:
148
      permissions:
148
      permissions:
149
        acquisition: vendors_manage
149
        acquisition: vendors_manage
Lines 154-196 Link Here
154
      - vendors
154
      - vendors
155
    summary: Update vendor
155
    summary: Update vendor
156
    parameters:
156
    parameters:
157
      - $ref: ../parameters.yaml#/vendor_id_pp
157
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
158
      - name: body
158
      - name: body
159
        in: body
159
        in: body
160
        description: A JSON object representing a vendor
160
        description: A JSON object representing a vendor
161
        required: true
161
        required: true
162
        schema:
162
        schema:
163
          $ref: ../definitions.yaml#/vendor
163
          $ref: "../swagger.yaml#/definitions/vendor"
164
    produces:
164
    produces:
165
      - application/json
165
      - application/json
166
    responses:
166
    responses:
167
      "200":
167
      "200":
168
        description: A vendor
168
        description: A vendor
169
        schema:
169
        schema:
170
          $ref: ../definitions.yaml#/vendor
170
          $ref: "../swagger.yaml#/definitions/vendor"
171
      "401":
171
      "401":
172
        description: Authentication required
172
        description: Authentication required
173
        schema:
173
        schema:
174
          $ref: ../definitions.yaml#/error
174
          $ref: "../swagger.yaml#/definitions/error"
175
      "403":
175
      "403":
176
        description: Access forbidden
176
        description: Access forbidden
177
        schema:
177
        schema:
178
          $ref: ../definitions.yaml#/error
178
          $ref: "../swagger.yaml#/definitions/error"
179
      "404":
179
      "404":
180
        description: Vendor not found
180
        description: Vendor not found
181
        schema:
181
        schema:
182
          $ref: ../definitions.yaml#/error
182
          $ref: "../swagger.yaml#/definitions/error"
183
      "500":
183
      "500":
184
        description: |
184
        description: |
185
          Internal server error. Possible `error_code` attribute values:
185
          Internal server error. Possible `error_code` attribute values:
186
186
187
          * `internal_server_error`
187
          * `internal_server_error`
188
        schema:
188
        schema:
189
          $ref: ../definitions.yaml#/error
189
          $ref: "../swagger.yaml#/definitions/error"
190
      "503":
190
      "503":
191
        description: Under maintenance
191
        description: Under maintenance
192
        schema:
192
        schema:
193
          $ref: ../definitions.yaml#/error
193
          $ref: "../swagger.yaml#/definitions/error"
194
    x-koha-authorization:
194
    x-koha-authorization:
195
      permissions:
195
      permissions:
196
        acquisition: vendors_manage
196
        acquisition: vendors_manage
Lines 201-207 Link Here
201
      - vendors
201
      - vendors
202
    summary: Delete vendor
202
    summary: Delete vendor
203
    parameters:
203
    parameters:
204
      - $ref: ../parameters.yaml#/vendor_id_pp
204
      - $ref: "../swagger.yaml#/parameters/vendor_id_pp"
205
    produces:
205
    produces:
206
      - application/json
206
      - application/json
207
    responses:
207
    responses:
Lines 210-235 Link Here
210
      "401":
210
      "401":
211
        description: Authentication required
211
        description: Authentication required
212
        schema:
212
        schema:
213
          $ref: ../definitions.yaml#/error
213
          $ref: "../swagger.yaml#/definitions/error"
214
      "403":
214
      "403":
215
        description: Access forbidden
215
        description: Access forbidden
216
        schema:
216
        schema:
217
          $ref: ../definitions.yaml#/error
217
          $ref: "../swagger.yaml#/definitions/error"
218
      "404":
218
      "404":
219
        description: Vendor not found
219
        description: Vendor not found
220
        schema:
220
        schema:
221
          $ref: ../definitions.yaml#/error
221
          $ref: "../swagger.yaml#/definitions/error"
222
      "500":
222
      "500":
223
        description: |
223
        description: |
224
          Internal server error. Possible `error_code` attribute values:
224
          Internal server error. Possible `error_code` attribute values:
225
225
226
          * `internal_server_error`
226
          * `internal_server_error`
227
        schema:
227
        schema:
228
          $ref: ../definitions.yaml#/error
228
          $ref: "../swagger.yaml#/definitions/error"
229
      "503":
229
      "503":
230
        description: Under maintenance
230
        description: Under maintenance
231
        schema:
231
        schema:
232
          $ref: ../definitions.yaml#/error
232
          $ref: "../swagger.yaml#/definitions/error"
233
    x-koha-authorization:
233
    x-koha-authorization:
234
      permissions:
234
      permissions:
235
        acquisition: vendors_manage
235
        acquisition: vendors_manage
(-)a/api/v1/swagger/paths/advancededitormacros.yaml (-63 / +63 lines)
Lines 29-63 Link Here
29
        description: Search on shared macros
29
        description: Search on shared macros
30
        required: false
30
        required: false
31
        type: string
31
        type: string
32
      - $ref: ../parameters.yaml#/match
32
      - $ref: "../swagger.yaml#/parameters/match"
33
      - $ref: ../parameters.yaml#/order_by
33
      - $ref: "../swagger.yaml#/parameters/order_by"
34
      - $ref: ../parameters.yaml#/page
34
      - $ref: "../swagger.yaml#/parameters/page"
35
      - $ref: ../parameters.yaml#/per_page
35
      - $ref: "../swagger.yaml#/parameters/per_page"
36
      - $ref: ../parameters.yaml#/q_param
36
      - $ref: "../swagger.yaml#/parameters/q_param"
37
      - $ref: ../parameters.yaml#/q_body
37
      - $ref: "../swagger.yaml#/parameters/q_body"
38
      - $ref: ../parameters.yaml#/q_header
38
      - $ref: "../swagger.yaml#/parameters/q_header"
39
    responses:
39
    responses:
40
      "200":
40
      "200":
41
        description: A list of macros
41
        description: A list of macros
42
        schema:
42
        schema:
43
          type: array
43
          type: array
44
          items:
44
          items:
45
            $ref: ../definitions.yaml#/advancededitormacro
45
            $ref: "../swagger.yaml#/definitions/advancededitormacro"
46
      "403":
46
      "403":
47
        description: Access forbidden
47
        description: Access forbidden
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
      "500":
50
      "500":
51
        description: |
51
        description: |
52
          Internal server error. Possible `error_code` attribute values:
52
          Internal server error. Possible `error_code` attribute values:
53
53
54
          * `internal_server_error`
54
          * `internal_server_error`
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/error
56
          $ref: "../swagger.yaml#/definitions/error"
57
      "503":
57
      "503":
58
        description: Under maintenance
58
        description: Under maintenance
59
        schema:
59
        schema:
60
          $ref: ../definitions.yaml#/error
60
          $ref: "../swagger.yaml#/definitions/error"
61
    x-koha-authorization:
61
    x-koha-authorization:
62
      permissions:
62
      permissions:
63
        editcatalogue: advanced_editor
63
        editcatalogue: advanced_editor
Lines 73-102 Link Here
73
        description: A JSON object containing informations about the new macro
73
        description: A JSON object containing informations about the new macro
74
        required: true
74
        required: true
75
        schema:
75
        schema:
76
          $ref: ../definitions.yaml#/advancededitormacro
76
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
77
    produces:
77
    produces:
78
      - application/json
78
      - application/json
79
    responses:
79
    responses:
80
      "201":
80
      "201":
81
        description: Macro added
81
        description: Macro added
82
        schema:
82
        schema:
83
          $ref: ../definitions.yaml#/advancededitormacro
83
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
84
      "401":
84
      "401":
85
        description: Authentication required
85
        description: Authentication required
86
        schema:
86
        schema:
87
          $ref: ../definitions.yaml#/error
87
          $ref: "../swagger.yaml#/definitions/error"
88
      "403":
88
      "403":
89
        description: Access forbidden
89
        description: Access forbidden
90
        schema:
90
        schema:
91
          $ref: ../definitions.yaml#/error
91
          $ref: "../swagger.yaml#/definitions/error"
92
      "500":
92
      "500":
93
        description: Internal error
93
        description: Internal error
94
        schema:
94
        schema:
95
          $ref: ../definitions.yaml#/error
95
          $ref: "../swagger.yaml#/definitions/error"
96
      "503":
96
      "503":
97
        description: Under maintenance
97
        description: Under maintenance
98
        schema:
98
        schema:
99
          $ref: ../definitions.yaml#/error
99
          $ref: "../swagger.yaml#/definitions/error"
100
    x-koha-authorization:
100
    x-koha-authorization:
101
      permissions:
101
      permissions:
102
        editcatalogue: advanced_editor
102
        editcatalogue: advanced_editor
Lines 113-142 Link Here
113
        description: A JSON object containing informations about the new macro
113
        description: A JSON object containing informations about the new macro
114
        required: true
114
        required: true
115
        schema:
115
        schema:
116
          $ref: ../definitions.yaml#/advancededitormacro
116
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
117
    produces:
117
    produces:
118
      - application/json
118
      - application/json
119
    responses:
119
    responses:
120
      "201":
120
      "201":
121
        description: Macro added
121
        description: Macro added
122
        schema:
122
        schema:
123
          $ref: ../definitions.yaml#/advancededitormacro
123
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
124
      "401":
124
      "401":
125
        description: Authentication required
125
        description: Authentication required
126
        schema:
126
        schema:
127
          $ref: ../definitions.yaml#/error
127
          $ref: "../swagger.yaml#/definitions/error"
128
      "403":
128
      "403":
129
        description: Access forbidden
129
        description: Access forbidden
130
        schema:
130
        schema:
131
          $ref: ../definitions.yaml#/error
131
          $ref: "../swagger.yaml#/definitions/error"
132
      "500":
132
      "500":
133
        description: Internal error
133
        description: Internal error
134
        schema:
134
        schema:
135
          $ref: ../definitions.yaml#/error
135
          $ref: "../swagger.yaml#/definitions/error"
136
      "503":
136
      "503":
137
        description: Under maintenance
137
        description: Under maintenance
138
        schema:
138
        schema:
139
          $ref: ../definitions.yaml#/error
139
          $ref: "../swagger.yaml#/definitions/error"
140
    x-koha-authorization:
140
    x-koha-authorization:
141
      permissions:
141
      permissions:
142
        editcatalogue:
142
        editcatalogue:
Lines 150-179 Link Here
150
      - macros
150
      - macros
151
    summary: Get advanced editor macro
151
    summary: Get advanced editor macro
152
    parameters:
152
    parameters:
153
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
153
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
154
    produces:
154
    produces:
155
      - application/json
155
      - application/json
156
    responses:
156
    responses:
157
      "200":
157
      "200":
158
        description: A macro
158
        description: A macro
159
        schema:
159
        schema:
160
          $ref: ../definitions.yaml#/advancededitormacro
160
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
161
      "403":
161
      "403":
162
        description: Access forbidden
162
        description: Access forbidden
163
        schema:
163
        schema:
164
          $ref: ../definitions.yaml#/error
164
          $ref: "../swagger.yaml#/definitions/error"
165
      "404":
165
      "404":
166
        description: AdvancedEditorMacro not found
166
        description: AdvancedEditorMacro not found
167
        schema:
167
        schema:
168
          $ref: ../definitions.yaml#/error
168
          $ref: "../swagger.yaml#/definitions/error"
169
      "500":
169
      "500":
170
        description: Internal error
170
        description: Internal error
171
        schema:
171
        schema:
172
          $ref: ../definitions.yaml#/error
172
          $ref: "../swagger.yaml#/definitions/error"
173
      "503":
173
      "503":
174
        description: Under maintenance
174
        description: Under maintenance
175
        schema:
175
        schema:
176
          $ref: ../definitions.yaml#/error
176
          $ref: "../swagger.yaml#/definitions/error"
177
    x-koha-authorization:
177
    x-koha-authorization:
178
      permissions:
178
      permissions:
179
        editcatalogue: advanced_editor
179
        editcatalogue: advanced_editor
Lines 184-223 Link Here
184
      - macros
184
      - macros
185
    summary: Update advanced editor macro
185
    summary: Update advanced editor macro
186
    parameters:
186
    parameters:
187
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
187
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
188
      - name: body
188
      - name: body
189
        in: body
189
        in: body
190
        description: An advanced editor macro object
190
        description: An advanced editor macro object
191
        required: true
191
        required: true
192
        schema:
192
        schema:
193
          $ref: ../definitions.yaml#/advancededitormacro
193
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
194
    produces:
194
    produces:
195
      - application/json
195
      - application/json
196
    responses:
196
    responses:
197
      "200":
197
      "200":
198
        description: An advanced editor macro
198
        description: An advanced editor macro
199
        schema:
199
        schema:
200
          $ref: ../definitions.yaml#/advancededitormacro
200
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
201
      "401":
201
      "401":
202
        description: Authentication required
202
        description: Authentication required
203
        schema:
203
        schema:
204
          $ref: ../definitions.yaml#/error
204
          $ref: "../swagger.yaml#/definitions/error"
205
      "403":
205
      "403":
206
        description: Access forbidden
206
        description: Access forbidden
207
        schema:
207
        schema:
208
          $ref: ../definitions.yaml#/error
208
          $ref: "../swagger.yaml#/definitions/error"
209
      "404":
209
      "404":
210
        description: Macro not found
210
        description: Macro not found
211
        schema:
211
        schema:
212
          $ref: ../definitions.yaml#/error
212
          $ref: "../swagger.yaml#/definitions/error"
213
      "500":
213
      "500":
214
        description: Internal error
214
        description: Internal error
215
        schema:
215
        schema:
216
          $ref: ../definitions.yaml#/error
216
          $ref: "../swagger.yaml#/definitions/error"
217
      "503":
217
      "503":
218
        description: Under maintenance
218
        description: Under maintenance
219
        schema:
219
        schema:
220
          $ref: ../definitions.yaml#/error
220
          $ref: "../swagger.yaml#/definitions/error"
221
    x-koha-authorization:
221
    x-koha-authorization:
222
      permissions:
222
      permissions:
223
        editcatalogue: advanced_editor
223
        editcatalogue: advanced_editor
Lines 228-234 Link Here
228
      - macros
228
      - macros
229
    summary: Delete advanced editor macro
229
    summary: Delete advanced editor macro
230
    parameters:
230
    parameters:
231
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
231
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
232
    produces:
232
    produces:
233
      - application/json
233
      - application/json
234
    responses:
234
    responses:
Lines 239-261 Link Here
239
      "401":
239
      "401":
240
        description: Authentication required
240
        description: Authentication required
241
        schema:
241
        schema:
242
          $ref: ../definitions.yaml#/error
242
          $ref: "../swagger.yaml#/definitions/error"
243
      "403":
243
      "403":
244
        description: Access forbidden
244
        description: Access forbidden
245
        schema:
245
        schema:
246
          $ref: ../definitions.yaml#/error
246
          $ref: "../swagger.yaml#/definitions/error"
247
      "404":
247
      "404":
248
        description: Macro not found
248
        description: Macro not found
249
        schema:
249
        schema:
250
          $ref: ../definitions.yaml#/error
250
          $ref: "../swagger.yaml#/definitions/error"
251
      "500":
251
      "500":
252
        description: Internal error
252
        description: Internal error
253
        schema:
253
        schema:
254
          $ref: ../definitions.yaml#/error
254
          $ref: "../swagger.yaml#/definitions/error"
255
      "503":
255
      "503":
256
        description: Under maintenance
256
        description: Under maintenance
257
        schema:
257
        schema:
258
          $ref: ../definitions.yaml#/error
258
          $ref: "../swagger.yaml#/definitions/error"
259
    x-koha-authorization:
259
    x-koha-authorization:
260
      permissions:
260
      permissions:
261
        editcatalogue: advanced_editor
261
        editcatalogue: advanced_editor
Lines 267-296 Link Here
267
      - macros
267
      - macros
268
    summary: Get shared advanced editor macro
268
    summary: Get shared advanced editor macro
269
    parameters:
269
    parameters:
270
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
270
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
271
    produces:
271
    produces:
272
      - application/json
272
      - application/json
273
    responses:
273
    responses:
274
      "200":
274
      "200":
275
        description: A macro
275
        description: A macro
276
        schema:
276
        schema:
277
          $ref: ../definitions.yaml#/advancededitormacro
277
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
278
      "403":
278
      "403":
279
        description: Access forbidden
279
        description: Access forbidden
280
        schema:
280
        schema:
281
          $ref: ../definitions.yaml#/error
281
          $ref: "../swagger.yaml#/definitions/error"
282
      "404":
282
      "404":
283
        description: AdvancedEditorMacro not found
283
        description: AdvancedEditorMacro not found
284
        schema:
284
        schema:
285
          $ref: ../definitions.yaml#/error
285
          $ref: "../swagger.yaml#/definitions/error"
286
      "500":
286
      "500":
287
        description: Internal error
287
        description: Internal error
288
        schema:
288
        schema:
289
          $ref: ../definitions.yaml#/error
289
          $ref: "../swagger.yaml#/definitions/error"
290
      "503":
290
      "503":
291
        description: Under maintenance
291
        description: Under maintenance
292
        schema:
292
        schema:
293
          $ref: ../definitions.yaml#/error
293
          $ref: "../swagger.yaml#/definitions/error"
294
    x-koha-authorization:
294
    x-koha-authorization:
295
      permissions:
295
      permissions:
296
        editcatalogue: advanced_editor
296
        editcatalogue: advanced_editor
Lines 301-340 Link Here
301
      - macros
301
      - macros
302
    summary: Update shared advanced editor macro
302
    summary: Update shared advanced editor macro
303
    parameters:
303
    parameters:
304
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
304
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
305
      - name: body
305
      - name: body
306
        in: body
306
        in: body
307
        description: An advanced editor macro object
307
        description: An advanced editor macro object
308
        required: true
308
        required: true
309
        schema:
309
        schema:
310
          $ref: ../definitions.yaml#/advancededitormacro
310
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
311
    produces:
311
    produces:
312
      - application/json
312
      - application/json
313
    responses:
313
    responses:
314
      "200":
314
      "200":
315
        description: An advanced editor macro
315
        description: An advanced editor macro
316
        schema:
316
        schema:
317
          $ref: ../definitions.yaml#/advancededitormacro
317
          $ref: "../swagger.yaml#/definitions/advancededitormacro"
318
      "401":
318
      "401":
319
        description: Authentication required
319
        description: Authentication required
320
        schema:
320
        schema:
321
          $ref: ../definitions.yaml#/error
321
          $ref: "../swagger.yaml#/definitions/error"
322
      "403":
322
      "403":
323
        description: Access forbidden
323
        description: Access forbidden
324
        schema:
324
        schema:
325
          $ref: ../definitions.yaml#/error
325
          $ref: "../swagger.yaml#/definitions/error"
326
      "404":
326
      "404":
327
        description: Macro not found
327
        description: Macro not found
328
        schema:
328
        schema:
329
          $ref: ../definitions.yaml#/error
329
          $ref: "../swagger.yaml#/definitions/error"
330
      "500":
330
      "500":
331
        description: Internal error
331
        description: Internal error
332
        schema:
332
        schema:
333
          $ref: ../definitions.yaml#/error
333
          $ref: "../swagger.yaml#/definitions/error"
334
      "503":
334
      "503":
335
        description: Under maintenance
335
        description: Under maintenance
336
        schema:
336
        schema:
337
          $ref: ../definitions.yaml#/error
337
          $ref: "../swagger.yaml#/definitions/error"
338
    x-koha-authorization:
338
    x-koha-authorization:
339
      permissions:
339
      permissions:
340
        editcatalogue:
340
        editcatalogue:
Lines 347-353 Link Here
347
      - macros
347
      - macros
348
    summary: Delete shared advanced editor macro
348
    summary: Delete shared advanced editor macro
349
    parameters:
349
    parameters:
350
      - $ref: ../parameters.yaml#/advancededitormacro_id_pp
350
      - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp"
351
    produces:
351
    produces:
352
      - application/json
352
      - application/json
353
    responses:
353
    responses:
Lines 358-380 Link Here
358
      "401":
358
      "401":
359
        description: Authentication required
359
        description: Authentication required
360
        schema:
360
        schema:
361
          $ref: ../definitions.yaml#/error
361
          $ref: "../swagger.yaml#/definitions/error"
362
      "403":
362
      "403":
363
        description: Access forbidden
363
        description: Access forbidden
364
        schema:
364
        schema:
365
          $ref: ../definitions.yaml#/error
365
          $ref: "../swagger.yaml#/definitions/error"
366
      "404":
366
      "404":
367
        description: Macro not found
367
        description: Macro not found
368
        schema:
368
        schema:
369
          $ref: ../definitions.yaml#/error
369
          $ref: "../swagger.yaml#/definitions/error"
370
      "500":
370
      "500":
371
        description: Internal error
371
        description: Internal error
372
        schema:
372
        schema:
373
          $ref: ../definitions.yaml#/error
373
          $ref: "../swagger.yaml#/definitions/error"
374
      "503":
374
      "503":
375
        description: Under maintenance
375
        description: Under maintenance
376
        schema:
376
        schema:
377
          $ref: ../definitions.yaml#/error
377
          $ref: "../swagger.yaml#/definitions/error"
378
    x-koha-authorization:
378
    x-koha-authorization:
379
      permissions:
379
      permissions:
380
        editcatalogue:
380
        editcatalogue:
(-)a/api/v1/swagger/paths/article_requests.yaml (-13 / +13 lines)
Lines 30-59 Link Here
30
      "400":
30
      "400":
31
        description: Bad request
31
        description: Bad request
32
        schema:
32
        schema:
33
          $ref: ../definitions.yaml#/error
33
          $ref: "../swagger.yaml#/definitions/error"
34
      "401":
34
      "401":
35
        description: Authentication required
35
        description: Authentication required
36
        schema:
36
        schema:
37
          $ref: ../definitions.yaml#/error
37
          $ref: "../swagger.yaml#/definitions/error"
38
      "403":
38
      "403":
39
        description: Access forbidden
39
        description: Access forbidden
40
        schema:
40
        schema:
41
          $ref: ../definitions.yaml#/error
41
          $ref: "../swagger.yaml#/definitions/error"
42
      "404":
42
      "404":
43
        description: Patron not found
43
        description: Patron not found
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "500":
46
      "500":
47
        description: |
47
        description: |
48
          Internal server error. Possible `error_code` attribute values:
48
          Internal server error. Possible `error_code` attribute values:
49
49
50
          * `internal_server_error`
50
          * `internal_server_error`
51
        schema:
51
        schema:
52
          $ref: ../definitions.yaml#/error
52
          $ref: "../swagger.yaml#/definitions/error"
53
      "503":
53
      "503":
54
        description: Under maintenance
54
        description: Under maintenance
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/error
56
          $ref: "../swagger.yaml#/definitions/error"
57
    x-koha-authorization:
57
    x-koha-authorization:
58
      permissions:
58
      permissions:
59
        circulate: circulate_remaining_permissions
59
        circulate: circulate_remaining_permissions
Lines 65-71 Link Here
65
      - article_requests
65
      - article_requests
66
    summary: Cancel patron's article requests
66
    summary: Cancel patron's article requests
67
    parameters:
67
    parameters:
68
      - $ref: ../parameters.yaml#/patron_id_pp
68
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
69
      - name: article_request_id
69
      - name: article_request_id
70
        in: path
70
        in: path
71
        description: Article request identifier
71
        description: Article request identifier
Lines 89-117 Link Here
89
      "400":
89
      "400":
90
        description: Bad request
90
        description: Bad request
91
        schema:
91
        schema:
92
          $ref: ../definitions.yaml#/error
92
          $ref: "../swagger.yaml#/definitions/error"
93
      "401":
93
      "401":
94
        description: Authentication required
94
        description: Authentication required
95
        schema:
95
        schema:
96
          $ref: ../definitions.yaml#/error
96
          $ref: "../swagger.yaml#/definitions/error"
97
      "403":
97
      "403":
98
        description: Access forbidden
98
        description: Access forbidden
99
        schema:
99
        schema:
100
          $ref: ../definitions.yaml#/error
100
          $ref: "../swagger.yaml#/definitions/error"
101
      "404":
101
      "404":
102
        description: Patron not found
102
        description: Patron not found
103
        schema:
103
        schema:
104
          $ref: ../definitions.yaml#/error
104
          $ref: "../swagger.yaml#/definitions/error"
105
      "500":
105
      "500":
106
        description: |
106
        description: |
107
          Internal server error. Possible `error_code` attribute values:
107
          Internal server error. Possible `error_code` attribute values:
108
108
109
          * `internal_server_error`
109
          * `internal_server_error`
110
        schema:
110
        schema:
111
          $ref: ../definitions.yaml#/error
111
          $ref: "../swagger.yaml#/definitions/error"
112
      "503":
112
      "503":
113
        description: Under maintenance
113
        description: Under maintenance
114
        schema:
114
        schema:
115
          $ref: ../definitions.yaml#/error
115
          $ref: "../swagger.yaml#/definitions/error"
116
    x-koha-authorization:
116
    x-koha-authorization:
117
      allow-owner: true
117
      allow-owner: true
(-)a/api/v1/swagger/paths/biblios.yaml (-75 / +75 lines)
Lines 7-13 Link Here
7
      - biblios
7
      - biblios
8
    summary: Get biblio
8
    summary: Get biblio
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/biblio_id_pp
10
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
11
    produces:
11
    produces:
12
      - application/json
12
      - application/json
13
      - application/marcxml+xml
13
      - application/marcxml+xml
Lines 20-34 Link Here
20
      "401":
20
      "401":
21
        description: Authentication required
21
        description: Authentication required
22
        schema:
22
        schema:
23
          $ref: ../definitions.yaml#/error
23
          $ref: "../swagger.yaml#/definitions/error"
24
      "403":
24
      "403":
25
        description: Access forbidden
25
        description: Access forbidden
26
        schema:
26
        schema:
27
          $ref: ../definitions.yaml#/error
27
          $ref: "../swagger.yaml#/definitions/error"
28
      "404":
28
      "404":
29
        description: Biblio not found
29
        description: Biblio not found
30
        schema:
30
        schema:
31
          $ref: ../definitions.yaml#/error
31
          $ref: "../swagger.yaml#/definitions/error"
32
      "406":
32
      "406":
33
        description: Not acceptable
33
        description: Not acceptable
34
        schema:
34
        schema:
Lines 42-52 Link Here
42
42
43
          * `internal_server_error`
43
          * `internal_server_error`
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "503":
46
      "503":
47
        description: Under maintenance
47
        description: Under maintenance
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
    x-koha-authorization:
50
    x-koha-authorization:
51
      permissions:
51
      permissions:
52
        catalogue: "1"
52
        catalogue: "1"
Lines 57-63 Link Here
57
      - biblios
57
      - biblios
58
    summary: Delete biblio
58
    summary: Delete biblio
59
    parameters:
59
    parameters:
60
      - $ref: ../parameters.yaml#/biblio_id_pp
60
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
61
    produces:
61
    produces:
62
      - application/json
62
      - application/json
63
    responses:
63
    responses:
Lines 68-94 Link Here
68
      "401":
68
      "401":
69
        description: Authentication required
69
        description: Authentication required
70
        schema:
70
        schema:
71
          $ref: ../definitions.yaml#/error
71
          $ref: "../swagger.yaml#/definitions/error"
72
      "403":
72
      "403":
73
        description: Access forbidden
73
        description: Access forbidden
74
        schema:
74
        schema:
75
          $ref: ../definitions.yaml#/error
75
          $ref: "../swagger.yaml#/definitions/error"
76
      "404":
76
      "404":
77
        description: Biblio not found
77
        description: Biblio not found
78
        schema:
78
        schema:
79
          $ref: ../definitions.yaml#/error
79
          $ref: "../swagger.yaml#/definitions/error"
80
      "409":
80
      "409":
81
        description: Unable to perform action on biblio
81
        description: Unable to perform action on biblio
82
        schema:
82
        schema:
83
          $ref: ../definitions.yaml#/error
83
          $ref: "../swagger.yaml#/definitions/error"
84
      "500":
84
      "500":
85
        description: Internal error
85
        description: Internal error
86
        schema:
86
        schema:
87
          $ref: ../definitions.yaml#/error
87
          $ref: "../swagger.yaml#/definitions/error"
88
      "503":
88
      "503":
89
        description: Under maintenance
89
        description: Under maintenance
90
        schema:
90
        schema:
91
          $ref: ../definitions.yaml#/error
91
          $ref: "../swagger.yaml#/definitions/error"
92
    x-koha-authorization:
92
    x-koha-authorization:
93
      permissions:
93
      permissions:
94
        editcatalogue: edit_catalogue
94
        editcatalogue: edit_catalogue
Lines 100-113 Link Here
100
      - checkouts
100
      - checkouts
101
    summary: List checkouts for a biblio
101
    summary: List checkouts for a biblio
102
    parameters:
102
    parameters:
103
      - $ref: ../parameters.yaml#/biblio_id_pp
103
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
104
      - $ref: ../parameters.yaml#/page
104
      - $ref: "../swagger.yaml#/parameters/page"
105
      - $ref: ../parameters.yaml#/per_page
105
      - $ref: "../swagger.yaml#/parameters/per_page"
106
      - $ref: ../parameters.yaml#/match
106
      - $ref: "../swagger.yaml#/parameters/match"
107
      - $ref: ../parameters.yaml#/order_by
107
      - $ref: "../swagger.yaml#/parameters/order_by"
108
      - $ref: ../parameters.yaml#/q_param
108
      - $ref: "../swagger.yaml#/parameters/q_param"
109
      - $ref: ../parameters.yaml#/q_body
109
      - $ref: "../swagger.yaml#/parameters/q_body"
110
      - $ref: ../parameters.yaml#/q_header
110
      - $ref: "../swagger.yaml#/parameters/q_header"
111
      - name: checked_in
111
      - name: checked_in
112
        in: query
112
        in: query
113
        description: By default, current checkouts are returned, when this is true then
113
        description: By default, current checkouts are returned, when this is true then
Lines 119-144 Link Here
119
      "200":
119
      "200":
120
        description: A list of checkouts
120
        description: A list of checkouts
121
        schema:
121
        schema:
122
          $ref: ../definitions.yaml#/checkouts
122
          $ref: "../swagger.yaml#/definitions/checkouts"
123
      "403":
123
      "403":
124
        description: Access forbidden
124
        description: Access forbidden
125
        schema:
125
        schema:
126
          $ref: ../definitions.yaml#/error
126
          $ref: "../swagger.yaml#/definitions/error"
127
      "404":
127
      "404":
128
        description: Biblio not found
128
        description: Biblio not found
129
        schema:
129
        schema:
130
          $ref: ../definitions.yaml#/error
130
          $ref: "../swagger.yaml#/definitions/error"
131
      "500":
131
      "500":
132
        description: |
132
        description: |
133
          Internal server error. Possible `error_code` attribute values:
133
          Internal server error. Possible `error_code` attribute values:
134
134
135
          * `internal_server_error`
135
          * `internal_server_error`
136
        schema:
136
        schema:
137
          $ref: ../definitions.yaml#/error
137
          $ref: "../swagger.yaml#/definitions/error"
138
      "503":
138
      "503":
139
        description: Under maintenance
139
        description: Under maintenance
140
        schema:
140
        schema:
141
          $ref: ../definitions.yaml#/error
141
          $ref: "../swagger.yaml#/definitions/error"
142
    x-koha-authorization:
142
    x-koha-authorization:
143
      permissions:
143
      permissions:
144
        circulate: circulate_remaining_permissions
144
        circulate: circulate_remaining_permissions
Lines 155-168 Link Here
155
      - biblios
155
      - biblios
156
    summary: Get items for a biblio
156
    summary: Get items for a biblio
157
    parameters:
157
    parameters:
158
      - $ref: ../parameters.yaml#/biblio_id_pp
158
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
159
      - $ref: ../parameters.yaml#/match
159
      - $ref: "../swagger.yaml#/parameters/match"
160
      - $ref: ../parameters.yaml#/order_by
160
      - $ref: "../swagger.yaml#/parameters/order_by"
161
      - $ref: ../parameters.yaml#/page
161
      - $ref: "../swagger.yaml#/parameters/page"
162
      - $ref: ../parameters.yaml#/per_page
162
      - $ref: "../swagger.yaml#/parameters/per_page"
163
      - $ref: ../parameters.yaml#/q_param
163
      - $ref: "../swagger.yaml#/parameters/q_param"
164
      - $ref: ../parameters.yaml#/q_body
164
      - $ref: "../swagger.yaml#/parameters/q_body"
165
      - $ref: ../parameters.yaml#/q_header
165
      - $ref: "../swagger.yaml#/parameters/q_header"
166
    consumes:
166
    consumes:
167
      - application/json
167
      - application/json
168
    produces:
168
    produces:
Lines 173-191 Link Here
173
        schema:
173
        schema:
174
          type: array
174
          type: array
175
          items:
175
          items:
176
            $ref: ../definitions.yaml#/item
176
            $ref: "../swagger.yaml#/definitions/item"
177
      "401":
177
      "401":
178
        description: Authentication required
178
        description: Authentication required
179
        schema:
179
        schema:
180
          $ref: ../definitions.yaml#/error
180
          $ref: "../swagger.yaml#/definitions/error"
181
      "403":
181
      "403":
182
        description: Access forbidden
182
        description: Access forbidden
183
        schema:
183
        schema:
184
          $ref: ../definitions.yaml#/error
184
          $ref: "../swagger.yaml#/definitions/error"
185
      "404":
185
      "404":
186
        description: Biblio not found
186
        description: Biblio not found
187
        schema:
187
        schema:
188
          $ref: ../definitions.yaml#/error
188
          $ref: "../swagger.yaml#/definitions/error"
189
      "406":
189
      "406":
190
        description: Not acceptable
190
        description: Not acceptable
191
        schema:
191
        schema:
Lines 199-209 Link Here
199
199
200
          * `internal_server_error`
200
          * `internal_server_error`
201
        schema:
201
        schema:
202
          $ref: ../definitions.yaml#/error
202
          $ref: "../swagger.yaml#/definitions/error"
203
      "503":
203
      "503":
204
        description: Under maintenance
204
        description: Under maintenance
205
        schema:
205
        schema:
206
          $ref: ../definitions.yaml#/error
206
          $ref: "../swagger.yaml#/definitions/error"
207
    x-koha-authorization:
207
    x-koha-authorization:
208
      permissions:
208
      permissions:
209
        catalogue: "1"
209
        catalogue: "1"
Lines 215-233 Link Here
215
      - biblios
215
      - biblios
216
    summary: Get valid pickup locations for a biblio
216
    summary: Get valid pickup locations for a biblio
217
    parameters:
217
    parameters:
218
      - $ref: ../parameters.yaml#/biblio_id_pp
218
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
219
      - name: patron_id
219
      - name: patron_id
220
        in: query
220
        in: query
221
        description: Internal patron identifier
221
        description: Internal patron identifier
222
        required: true
222
        required: true
223
        type: integer
223
        type: integer
224
      - $ref: ../parameters.yaml#/match
224
      - $ref: "../swagger.yaml#/parameters/match"
225
      - $ref: ../parameters.yaml#/order_by
225
      - $ref: "../swagger.yaml#/parameters/order_by"
226
      - $ref: ../parameters.yaml#/page
226
      - $ref: "../swagger.yaml#/parameters/page"
227
      - $ref: ../parameters.yaml#/per_page
227
      - $ref: "../swagger.yaml#/parameters/per_page"
228
      - $ref: ../parameters.yaml#/q_param
228
      - $ref: "../swagger.yaml#/parameters/q_param"
229
      - $ref: ../parameters.yaml#/q_body
229
      - $ref: "../swagger.yaml#/parameters/q_body"
230
      - $ref: ../parameters.yaml#/q_header
230
      - $ref: "../swagger.yaml#/parameters/q_header"
231
    consumes:
231
    consumes:
232
      - application/json
232
      - application/json
233
    produces:
233
    produces:
Lines 238-271 Link Here
238
        schema:
238
        schema:
239
          type: array
239
          type: array
240
          items:
240
          items:
241
            $ref: ../definitions.yaml#/library
241
            $ref: "../swagger.yaml#/definitions/library"
242
      "400":
242
      "400":
243
        description: Missing or wrong parameters
243
        description: Missing or wrong parameters
244
        schema:
244
        schema:
245
          $ref: ../definitions.yaml#/error
245
          $ref: "../swagger.yaml#/definitions/error"
246
      "401":
246
      "401":
247
        description: Authentication required
247
        description: Authentication required
248
        schema:
248
        schema:
249
          $ref: ../definitions.yaml#/error
249
          $ref: "../swagger.yaml#/definitions/error"
250
      "403":
250
      "403":
251
        description: Access forbidden
251
        description: Access forbidden
252
        schema:
252
        schema:
253
          $ref: ../definitions.yaml#/error
253
          $ref: "../swagger.yaml#/definitions/error"
254
      "404":
254
      "404":
255
        description: Biblio not found
255
        description: Biblio not found
256
        schema:
256
        schema:
257
          $ref: ../definitions.yaml#/error
257
          $ref: "../swagger.yaml#/definitions/error"
258
      "500":
258
      "500":
259
        description: |
259
        description: |
260
          Internal server error. Possible `error_code` attribute values:
260
          Internal server error. Possible `error_code` attribute values:
261
261
262
          * `internal_server_error`
262
          * `internal_server_error`
263
        schema:
263
        schema:
264
          $ref: ../definitions.yaml#/error
264
          $ref: "../swagger.yaml#/definitions/error"
265
      "503":
265
      "503":
266
        description: Under maintenance
266
        description: Under maintenance
267
        schema:
267
        schema:
268
          $ref: ../definitions.yaml#/error
268
          $ref: "../swagger.yaml#/definitions/error"
269
    x-koha-authorization:
269
    x-koha-authorization:
270
      permissions:
270
      permissions:
271
        reserveforothers: place_holds
271
        reserveforothers: place_holds
Lines 277-283 Link Here
277
      - biblios
277
      - biblios
278
    summary: Get biblio (public)
278
    summary: Get biblio (public)
279
    parameters:
279
    parameters:
280
      - $ref: ../parameters.yaml#/biblio_id_pp
280
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
281
    produces:
281
    produces:
282
      - application/marcxml+xml
282
      - application/marcxml+xml
283
      - application/marc-in-json
283
      - application/marc-in-json
Lines 289-303 Link Here
289
      "401":
289
      "401":
290
        description: Authentication required
290
        description: Authentication required
291
        schema:
291
        schema:
292
          $ref: ../definitions.yaml#/error
292
          $ref: "../swagger.yaml#/definitions/error"
293
      "403":
293
      "403":
294
        description: Access forbidden
294
        description: Access forbidden
295
        schema:
295
        schema:
296
          $ref: ../definitions.yaml#/error
296
          $ref: "../swagger.yaml#/definitions/error"
297
      "404":
297
      "404":
298
        description: Biblio not found
298
        description: Biblio not found
299
        schema:
299
        schema:
300
          $ref: ../definitions.yaml#/error
300
          $ref: "../swagger.yaml#/definitions/error"
301
      "406":
301
      "406":
302
        description: Not acceptable
302
        description: Not acceptable
303
        schema:
303
        schema:
Lines 311-321 Link Here
311
311
312
          * `internal_server_error`
312
          * `internal_server_error`
313
        schema:
313
        schema:
314
          $ref: ../definitions.yaml#/error
314
          $ref: "../swagger.yaml#/definitions/error"
315
      "503":
315
      "503":
316
        description: Under maintenance
316
        description: Under maintenance
317
        schema:
317
        schema:
318
          $ref: ../definitions.yaml#/error
318
          $ref: "../swagger.yaml#/definitions/error"
319
"/public/biblios/{biblio_id}/items":
319
"/public/biblios/{biblio_id}/items":
320
  get:
320
  get:
321
    x-mojo-to: Biblios#get_items_public
321
    x-mojo-to: Biblios#get_items_public
Lines 324-337 Link Here
324
      - biblios
324
      - biblios
325
      - items
325
      - items
326
    parameters:
326
    parameters:
327
      - $ref: ../parameters.yaml#/biblio_id_pp
327
      - $ref: "../swagger.yaml#/parameters/biblio_id_pp"
328
      - $ref: ../parameters.yaml#/match
328
      - $ref: "../swagger.yaml#/parameters/match"
329
      - $ref: ../parameters.yaml#/order_by
329
      - $ref: "../swagger.yaml#/parameters/order_by"
330
      - $ref: ../parameters.yaml#/page
330
      - $ref: "../swagger.yaml#/parameters/page"
331
      - $ref: ../parameters.yaml#/per_page
331
      - $ref: "../swagger.yaml#/parameters/per_page"
332
      - $ref: ../parameters.yaml#/q_param
332
      - $ref: "../swagger.yaml#/parameters/q_param"
333
      - $ref: ../parameters.yaml#/q_body
333
      - $ref: "../swagger.yaml#/parameters/q_body"
334
      - $ref: ../parameters.yaml#/q_header
334
      - $ref: "../swagger.yaml#/parameters/q_header"
335
    consumes:
335
    consumes:
336
      - application/json
336
      - application/json
337
    produces:
337
    produces:
Lines 342-360 Link Here
342
        schema:
342
        schema:
343
          type: array
343
          type: array
344
          items:
344
          items:
345
            $ref: ../definitions.yaml#/item
345
            $ref: "../swagger.yaml#/definitions/item"
346
      "401":
346
      "401":
347
        description: Authentication required
347
        description: Authentication required
348
        schema:
348
        schema:
349
          $ref: ../definitions.yaml#/error
349
          $ref: "../swagger.yaml#/definitions/error"
350
      "403":
350
      "403":
351
        description: Access forbidden
351
        description: Access forbidden
352
        schema:
352
        schema:
353
          $ref: ../definitions.yaml#/error
353
          $ref: "../swagger.yaml#/definitions/error"
354
      "404":
354
      "404":
355
        description: Biblio not found
355
        description: Biblio not found
356
        schema:
356
        schema:
357
          $ref: ../definitions.yaml#/error
357
          $ref: "../swagger.yaml#/definitions/error"
358
      "406":
358
      "406":
359
        description: Not acceptable
359
        description: Not acceptable
360
        schema:
360
        schema:
Lines 368-375 Link Here
368
368
369
          * `internal_server_error`
369
          * `internal_server_error`
370
        schema:
370
        schema:
371
          $ref: ../definitions.yaml#/error
371
          $ref: "../swagger.yaml#/definitions/error"
372
      "503":
372
      "503":
373
        description: Under maintenance
373
        description: Under maintenance
374
        schema:
374
        schema:
375
          $ref: ../definitions.yaml#/error
375
          $ref: "../swagger.yaml#/definitions/error"
(-)a/api/v1/swagger/paths/cash_registers.yaml (-19 / +19 lines)
Lines 9-48 Link Here
9
    produces:
9
    produces:
10
      - application/json
10
      - application/json
11
    parameters:
11
    parameters:
12
      - $ref: ../parameters.yaml#/cash_register_id_pp
12
      - $ref: "../swagger.yaml#/parameters/cash_register_id_pp"
13
      - $ref: ../parameters.yaml#/match
13
      - $ref: "../swagger.yaml#/parameters/match"
14
      - $ref: ../parameters.yaml#/order_by
14
      - $ref: "../swagger.yaml#/parameters/order_by"
15
      - $ref: ../parameters.yaml#/page
15
      - $ref: "../swagger.yaml#/parameters/page"
16
      - $ref: ../parameters.yaml#/per_page
16
      - $ref: "../swagger.yaml#/parameters/per_page"
17
      - $ref: ../parameters.yaml#/q_param
17
      - $ref: "../swagger.yaml#/parameters/q_param"
18
      - $ref: ../parameters.yaml#/q_body
18
      - $ref: "../swagger.yaml#/parameters/q_body"
19
      - $ref: ../parameters.yaml#/q_header
19
      - $ref: "../swagger.yaml#/parameters/q_header"
20
    responses:
20
    responses:
21
      "200":
21
      "200":
22
        description: Cashups performed on this register
22
        description: Cashups performed on this register
23
        schema:
23
        schema:
24
          type: array
24
          type: array
25
          items:
25
          items:
26
            $ref: ../definitions.yaml#/cashup
26
            $ref: "../swagger.yaml#/definitions/cashup"
27
      "403":
27
      "403":
28
        description: Access forbidden
28
        description: Access forbidden
29
        schema:
29
        schema:
30
          $ref: ../definitions.yaml#/error
30
          $ref: "../swagger.yaml#/definitions/error"
31
      "404":
31
      "404":
32
        description: Register not found
32
        description: Register not found
33
        schema:
33
        schema:
34
          $ref: ../definitions.yaml#/error
34
          $ref: "../swagger.yaml#/definitions/error"
35
      "500":
35
      "500":
36
        description: |
36
        description: |
37
          Internal server error. Possible `error_code` attribute values:
37
          Internal server error. Possible `error_code` attribute values:
38
38
39
          * `internal_server_error`
39
          * `internal_server_error`
40
        schema:
40
        schema:
41
          $ref: ../definitions.yaml#/error
41
          $ref: "../swagger.yaml#/definitions/error"
42
      "503":
42
      "503":
43
        description: Under maintenance
43
        description: Under maintenance
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
    x-koha-authorization:
46
    x-koha-authorization:
47
      permissions:
47
      permissions:
48
        cash_management: cashup
48
        cash_management: cashup
Lines 56-88 Link Here
56
      - cashups
56
      - cashups
57
    summary: Get cashup
57
    summary: Get cashup
58
    parameters:
58
    parameters:
59
      - $ref: ../parameters.yaml#/cashup_id_pp
59
      - $ref: "../swagger.yaml#/parameters/cashup_id_pp"
60
    produces:
60
    produces:
61
      - application/json
61
      - application/json
62
    responses:
62
    responses:
63
      "200":
63
      "200":
64
        description: A cashup
64
        description: A cashup
65
        schema:
65
        schema:
66
          $ref: ../definitions.yaml#/cashup
66
          $ref: "../swagger.yaml#/definitions/cashup"
67
      "403":
67
      "403":
68
        description: Access forbidden
68
        description: Access forbidden
69
        schema:
69
        schema:
70
          $ref: ../definitions.yaml#/error
70
          $ref: "../swagger.yaml#/definitions/error"
71
      "404":
71
      "404":
72
        description: Patron not found
72
        description: Patron not found
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/error
74
          $ref: "../swagger.yaml#/definitions/error"
75
      "500":
75
      "500":
76
        description: |
76
        description: |
77
          Internal server error. Possible `error_code` attribute values:
77
          Internal server error. Possible `error_code` attribute values:
78
78
79
          * `internal_server_error`
79
          * `internal_server_error`
80
        schema:
80
        schema:
81
          $ref: ../definitions.yaml#/error
81
          $ref: "../swagger.yaml#/definitions/error"
82
      "503":
82
      "503":
83
        description: Under maintenance
83
        description: Under maintenance
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
    x-koha-authorization:
86
    x-koha-authorization:
87
      permissions:
87
      permissions:
88
        cash_management: cashup
88
        cash_management: cashup
(-)a/api/v1/swagger/paths/checkouts.yaml (-32 / +32 lines)
Lines 7-20 Link Here
7
      - checkouts
7
      - checkouts
8
    summary: List checkouts
8
    summary: List checkouts
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_qp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_qp"
11
      - $ref: ../parameters.yaml#/page
11
      - $ref: "../swagger.yaml#/parameters/page"
12
      - $ref: ../parameters.yaml#/per_page
12
      - $ref: "../swagger.yaml#/parameters/per_page"
13
      - $ref: ../parameters.yaml#/match
13
      - $ref: "../swagger.yaml#/parameters/match"
14
      - $ref: ../parameters.yaml#/order_by
14
      - $ref: "../swagger.yaml#/parameters/order_by"
15
      - $ref: ../parameters.yaml#/q_param
15
      - $ref: "../swagger.yaml#/parameters/q_param"
16
      - $ref: ../parameters.yaml#/q_body
16
      - $ref: "../swagger.yaml#/parameters/q_body"
17
      - $ref: ../parameters.yaml#/q_header
17
      - $ref: "../swagger.yaml#/parameters/q_header"
18
      - name: checked_in
18
      - name: checked_in
19
        in: query
19
        in: query
20
        description: By default, current checkouts are returned, when this is true then
20
        description: By default, current checkouts are returned, when this is true then
Lines 26-51 Link Here
26
      "200":
26
      "200":
27
        description: A list of checkouts
27
        description: A list of checkouts
28
        schema:
28
        schema:
29
          $ref: ../definitions.yaml#/checkouts
29
          $ref: "../swagger.yaml#/definitions/checkouts"
30
      "403":
30
      "403":
31
        description: Access forbidden
31
        description: Access forbidden
32
        schema:
32
        schema:
33
          $ref: ../definitions.yaml#/error
33
          $ref: "../swagger.yaml#/definitions/error"
34
      "404":
34
      "404":
35
        description: Patron not found
35
        description: Patron not found
36
        schema:
36
        schema:
37
          $ref: ../definitions.yaml#/error
37
          $ref: "../swagger.yaml#/definitions/error"
38
      "500":
38
      "500":
39
        description: |
39
        description: |
40
          Internal server error. Possible `error_code` attribute values:
40
          Internal server error. Possible `error_code` attribute values:
41
41
42
          * `internal_server_error`
42
          * `internal_server_error`
43
        schema:
43
        schema:
44
          $ref: ../definitions.yaml#/error
44
          $ref: "../swagger.yaml#/definitions/error"
45
      "503":
45
      "503":
46
        description: Under maintenance
46
        description: Under maintenance
47
        schema:
47
        schema:
48
          $ref: ../definitions.yaml#/error
48
          $ref: "../swagger.yaml#/definitions/error"
49
    x-koha-authorization:
49
    x-koha-authorization:
50
      permissions:
50
      permissions:
51
        circulate: circulate_remaining_permissions
51
        circulate: circulate_remaining_permissions
Lines 59-91 Link Here
59
      - checkouts
59
      - checkouts
60
    summary: Get checkout
60
    summary: Get checkout
61
    parameters:
61
    parameters:
62
      - $ref: ../parameters.yaml#/checkout_id_pp
62
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
63
    produces:
63
    produces:
64
      - application/json
64
      - application/json
65
    responses:
65
    responses:
66
      "200":
66
      "200":
67
        description: Updated borrower's checkout
67
        description: Updated borrower's checkout
68
        schema:
68
        schema:
69
          $ref: ../definitions.yaml#/checkout
69
          $ref: "../swagger.yaml#/definitions/checkout"
70
      "403":
70
      "403":
71
        description: Access forbidden
71
        description: Access forbidden
72
        schema:
72
        schema:
73
          $ref: ../definitions.yaml#/error
73
          $ref: "../swagger.yaml#/definitions/error"
74
      "404":
74
      "404":
75
        description: Checkout not found
75
        description: Checkout not found
76
        schema:
76
        schema:
77
          $ref: ../definitions.yaml#/error
77
          $ref: "../swagger.yaml#/definitions/error"
78
      "500":
78
      "500":
79
        description: |
79
        description: |
80
          Internal server error. Possible `error_code` attribute values:
80
          Internal server error. Possible `error_code` attribute values:
81
81
82
          * `internal_server_error`
82
          * `internal_server_error`
83
        schema:
83
        schema:
84
          $ref: ../definitions.yaml#/error
84
          $ref: "../swagger.yaml#/definitions/error"
85
      "503":
85
      "503":
86
        description: Under maintenance
86
        description: Under maintenance
87
        schema:
87
        schema:
88
          $ref: ../definitions.yaml#/error
88
          $ref: "../swagger.yaml#/definitions/error"
89
    x-koha-authorization:
89
    x-koha-authorization:
90
      permissions:
90
      permissions:
91
        circulate: circulate_remaining_permissions
91
        circulate: circulate_remaining_permissions
Lines 99-132 Link Here
99
      - checkouts
99
      - checkouts
100
    summary: Renew a checkout
100
    summary: Renew a checkout
101
    parameters:
101
    parameters:
102
      - $ref: ../parameters.yaml#/checkout_id_pp
102
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
103
      - $ref: ../parameters.yaml#/seen_pp
103
      - $ref: "../swagger.yaml#/parameters/seen_pp"
104
    produces:
104
    produces:
105
      - application/json
105
      - application/json
106
    responses:
106
    responses:
107
      "201":
107
      "201":
108
        description: Updated borrower's checkout
108
        description: Updated borrower's checkout
109
        schema:
109
        schema:
110
          $ref: ../definitions.yaml#/checkout
110
          $ref: "../swagger.yaml#/definitions/checkout"
111
      "403":
111
      "403":
112
        description: Cannot renew checkout
112
        description: Cannot renew checkout
113
        schema:
113
        schema:
114
          $ref: ../definitions.yaml#/error
114
          $ref: "../swagger.yaml#/definitions/error"
115
      "404":
115
      "404":
116
        description: Checkout not found
116
        description: Checkout not found
117
        schema:
117
        schema:
118
          $ref: ../definitions.yaml#/error
118
          $ref: "../swagger.yaml#/definitions/error"
119
      "500":
119
      "500":
120
        description: |
120
        description: |
121
          Internal server error. Possible `error_code` attribute values:
121
          Internal server error. Possible `error_code` attribute values:
122
122
123
          * `internal_server_error`
123
          * `internal_server_error`
124
        schema:
124
        schema:
125
          $ref: ../definitions.yaml#/error
125
          $ref: "../swagger.yaml#/definitions/error"
126
      "503":
126
      "503":
127
        description: Under maintenance
127
        description: Under maintenance
128
        schema:
128
        schema:
129
          $ref: ../definitions.yaml#/error
129
          $ref: "../swagger.yaml#/definitions/error"
130
    x-koha-authorization:
130
    x-koha-authorization:
131
      permissions:
131
      permissions:
132
        circulate: circulate_remaining_permissions
132
        circulate: circulate_remaining_permissions
Lines 138-170 Link Here
138
      - checkouts
138
      - checkouts
139
    summary: Get renewability for a checkout
139
    summary: Get renewability for a checkout
140
    parameters:
140
    parameters:
141
      - $ref: ../parameters.yaml#/checkout_id_pp
141
      - $ref: "../swagger.yaml#/parameters/checkout_id_pp"
142
    produces:
142
    produces:
143
      - application/json
143
      - application/json
144
    responses:
144
    responses:
145
      "200":
145
      "200":
146
        description: Checkout renewability information
146
        description: Checkout renewability information
147
        schema:
147
        schema:
148
          $ref: ../definitions.yaml#/allows_renewal
148
          $ref: "../swagger.yaml#/definitions/allows_renewal"
149
      "403":
149
      "403":
150
        description: Forbidden
150
        description: Forbidden
151
        schema:
151
        schema:
152
          $ref: ../definitions.yaml#/error
152
          $ref: "../swagger.yaml#/definitions/error"
153
      "404":
153
      "404":
154
        description: Checkout not found
154
        description: Checkout not found
155
        schema:
155
        schema:
156
          $ref: ../definitions.yaml#/error
156
          $ref: "../swagger.yaml#/definitions/error"
157
      "500":
157
      "500":
158
        description: |
158
        description: |
159
          Internal server error. Possible `error_code` attribute values:
159
          Internal server error. Possible `error_code` attribute values:
160
160
161
          * `internal_server_error`
161
          * `internal_server_error`
162
        schema:
162
        schema:
163
          $ref: ../definitions.yaml#/error
163
          $ref: "../swagger.yaml#/definitions/error"
164
      "503":
164
      "503":
165
        description: Under maintenance
165
        description: Under maintenance
166
        schema:
166
        schema:
167
          $ref: ../definitions.yaml#/error
167
          $ref: "../swagger.yaml#/definitions/error"
168
    x-koha-authorization:
168
    x-koha-authorization:
169
      permissions:
169
      permissions:
170
        circulate: circulate_remaining_permissions
170
        circulate: circulate_remaining_permissions
(-)a/api/v1/swagger/paths/circulation-rules.yaml (-4 / +4 lines)
Lines 14-32 Link Here
14
        schema:
14
        schema:
15
          type: object
15
          type: object
16
          additionalProperties:
16
          additionalProperties:
17
            $ref: ../definitions.yaml#/circ-rule-kind
17
            $ref: "../swagger.yaml#/definitions/circ-rule-kind"
18
      "403":
18
      "403":
19
        description: Access forbidden
19
        description: Access forbidden
20
        schema:
20
        schema:
21
          $ref: ../definitions.yaml#/error
21
          $ref: "../swagger.yaml#/definitions/error"
22
      "500":
22
      "500":
23
        description: |
23
        description: |
24
          Internal server error. Possible `error_code` attribute values:
24
          Internal server error. Possible `error_code` attribute values:
25
25
26
          * `internal_server_error`
26
          * `internal_server_error`
27
        schema:
27
        schema:
28
          $ref: ../definitions.yaml#/error
28
          $ref: "../swagger.yaml#/definitions/error"
29
      "503":
29
      "503":
30
        description: Under maintenance
30
        description: Under maintenance
31
        schema:
31
        schema:
32
          $ref: ../definitions.yaml#/error
32
          $ref: "../swagger.yaml#/definitions/error"
(-)a/api/v1/swagger/paths/cities.yaml (-36 / +36 lines)
Lines 29-63 Link Here
29
        description: Case Insensative search on city postal code
29
        description: Case Insensative search on city postal code
30
        required: false
30
        required: false
31
        type: string
31
        type: string
32
      - $ref: ../parameters.yaml#/match
32
      - $ref: "../swagger.yaml#/parameters/match"
33
      - $ref: ../parameters.yaml#/order_by
33
      - $ref: "../swagger.yaml#/parameters/order_by"
34
      - $ref: ../parameters.yaml#/page
34
      - $ref: "../swagger.yaml#/parameters/page"
35
      - $ref: ../parameters.yaml#/per_page
35
      - $ref: "../swagger.yaml#/parameters/per_page"
36
      - $ref: ../parameters.yaml#/q_param
36
      - $ref: "../swagger.yaml#/parameters/q_param"
37
      - $ref: ../parameters.yaml#/q_body
37
      - $ref: "../swagger.yaml#/parameters/q_body"
38
      - $ref: ../parameters.yaml#/q_header
38
      - $ref: "../swagger.yaml#/parameters/q_header"
39
    responses:
39
    responses:
40
      "200":
40
      "200":
41
        description: A list of cities
41
        description: A list of cities
42
        schema:
42
        schema:
43
          type: array
43
          type: array
44
          items:
44
          items:
45
            $ref: ../definitions.yaml#/city
45
            $ref: "../swagger.yaml#/definitions/city"
46
      "403":
46
      "403":
47
        description: Access forbidden
47
        description: Access forbidden
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
      "500":
50
      "500":
51
        description: |
51
        description: |
52
          Internal server error. Possible `error_code` attribute values:
52
          Internal server error. Possible `error_code` attribute values:
53
53
54
          * `internal_server_error`
54
          * `internal_server_error`
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/error
56
          $ref: "../swagger.yaml#/definitions/error"
57
      "503":
57
      "503":
58
        description: Under maintenance
58
        description: Under maintenance
59
        schema:
59
        schema:
60
          $ref: ../definitions.yaml#/error
60
          $ref: "../swagger.yaml#/definitions/error"
61
    x-koha-authorization:
61
    x-koha-authorization:
62
      permissions:
62
      permissions:
63
        catalogue: "1"
63
        catalogue: "1"
Lines 73-105 Link Here
73
        description: A JSON object containing informations about the new hold
73
        description: A JSON object containing informations about the new hold
74
        required: true
74
        required: true
75
        schema:
75
        schema:
76
          $ref: ../definitions.yaml#/city
76
          $ref: "../swagger.yaml#/definitions/city"
77
    produces:
77
    produces:
78
      - application/json
78
      - application/json
79
    responses:
79
    responses:
80
      "201":
80
      "201":
81
        description: City added
81
        description: City added
82
        schema:
82
        schema:
83
          $ref: ../definitions.yaml#/city
83
          $ref: "../swagger.yaml#/definitions/city"
84
      "401":
84
      "401":
85
        description: Authentication required
85
        description: Authentication required
86
        schema:
86
        schema:
87
          $ref: ../definitions.yaml#/error
87
          $ref: "../swagger.yaml#/definitions/error"
88
      "403":
88
      "403":
89
        description: Access forbidden
89
        description: Access forbidden
90
        schema:
90
        schema:
91
          $ref: ../definitions.yaml#/error
91
          $ref: "../swagger.yaml#/definitions/error"
92
      "500":
92
      "500":
93
        description: |
93
        description: |
94
          Internal server error. Possible `error_code` attribute values:
94
          Internal server error. Possible `error_code` attribute values:
95
95
96
          * `internal_server_error`
96
          * `internal_server_error`
97
        schema:
97
        schema:
98
          $ref: ../definitions.yaml#/error
98
          $ref: "../swagger.yaml#/definitions/error"
99
      "503":
99
      "503":
100
        description: Under maintenance
100
        description: Under maintenance
101
        schema:
101
        schema:
102
          $ref: ../definitions.yaml#/error
102
          $ref: "../swagger.yaml#/definitions/error"
103
    x-koha-authorization:
103
    x-koha-authorization:
104
      permissions:
104
      permissions:
105
        parameters: manage_cities
105
        parameters: manage_cities
Lines 111-139 Link Here
111
      - cities
111
      - cities
112
    summary: Get city
112
    summary: Get city
113
    parameters:
113
    parameters:
114
      - $ref: ../parameters.yaml#/city_id_pp
114
      - $ref: "../swagger.yaml#/parameters/city_id_pp"
115
    produces:
115
    produces:
116
      - application/json
116
      - application/json
117
    responses:
117
    responses:
118
      "200":
118
      "200":
119
        description: A city
119
        description: A city
120
        schema:
120
        schema:
121
          $ref: ../definitions.yaml#/city
121
          $ref: "../swagger.yaml#/definitions/city"
122
      "404":
122
      "404":
123
        description: City not found
123
        description: City not found
124
        schema:
124
        schema:
125
          $ref: ../definitions.yaml#/error
125
          $ref: "../swagger.yaml#/definitions/error"
126
      "500":
126
      "500":
127
        description: |
127
        description: |
128
          Internal server error. Possible `error_code` attribute values:
128
          Internal server error. Possible `error_code` attribute values:
129
129
130
          * `internal_server_error`
130
          * `internal_server_error`
131
        schema:
131
        schema:
132
          $ref: ../definitions.yaml#/error
132
          $ref: "../swagger.yaml#/definitions/error"
133
      "503":
133
      "503":
134
        description: Under maintenance
134
        description: Under maintenance
135
        schema:
135
        schema:
136
          $ref: ../definitions.yaml#/error
136
          $ref: "../swagger.yaml#/definitions/error"
137
    x-koha-authorization:
137
    x-koha-authorization:
138
      permissions:
138
      permissions:
139
        catalogue: "1"
139
        catalogue: "1"
Lines 144-183 Link Here
144
      - cities
144
      - cities
145
    summary: Update city
145
    summary: Update city
146
    parameters:
146
    parameters:
147
      - $ref: ../parameters.yaml#/city_id_pp
147
      - $ref: "../swagger.yaml#/parameters/city_id_pp"
148
      - name: body
148
      - name: body
149
        in: body
149
        in: body
150
        description: A city object
150
        description: A city object
151
        required: true
151
        required: true
152
        schema:
152
        schema:
153
          $ref: ../definitions.yaml#/city
153
          $ref: "../swagger.yaml#/definitions/city"
154
    produces:
154
    produces:
155
      - application/json
155
      - application/json
156
    responses:
156
    responses:
157
      "200":
157
      "200":
158
        description: A city
158
        description: A city
159
        schema:
159
        schema:
160
          $ref: ../definitions.yaml#/city
160
          $ref: "../swagger.yaml#/definitions/city"
161
      "401":
161
      "401":
162
        description: Authentication required
162
        description: Authentication required
163
        schema:
163
        schema:
164
          $ref: ../definitions.yaml#/error
164
          $ref: "../swagger.yaml#/definitions/error"
165
      "403":
165
      "403":
166
        description: Access forbidden
166
        description: Access forbidden
167
        schema:
167
        schema:
168
          $ref: ../definitions.yaml#/error
168
          $ref: "../swagger.yaml#/definitions/error"
169
      "404":
169
      "404":
170
        description: City not found
170
        description: City not found
171
        schema:
171
        schema:
172
          $ref: ../definitions.yaml#/error
172
          $ref: "../swagger.yaml#/definitions/error"
173
      "500":
173
      "500":
174
        description: Internal error
174
        description: Internal error
175
        schema:
175
        schema:
176
          $ref: ../definitions.yaml#/error
176
          $ref: "../swagger.yaml#/definitions/error"
177
      "503":
177
      "503":
178
        description: Under maintenance
178
        description: Under maintenance
179
        schema:
179
        schema:
180
          $ref: ../definitions.yaml#/error
180
          $ref: "../swagger.yaml#/definitions/error"
181
    x-koha-authorization:
181
    x-koha-authorization:
182
      permissions:
182
      permissions:
183
        parameters: manage_cities
183
        parameters: manage_cities
Lines 188-194 Link Here
188
      - cities
188
      - cities
189
    summary: Delete city
189
    summary: Delete city
190
    parameters:
190
    parameters:
191
      - $ref: ../parameters.yaml#/city_id_pp
191
      - $ref: "../swagger.yaml#/parameters/city_id_pp"
192
    produces:
192
    produces:
193
      - application/json
193
      - application/json
194
    responses:
194
    responses:
Lines 197-219 Link Here
197
      "401":
197
      "401":
198
        description: Authentication required
198
        description: Authentication required
199
        schema:
199
        schema:
200
          $ref: ../definitions.yaml#/error
200
          $ref: "../swagger.yaml#/definitions/error"
201
      "403":
201
      "403":
202
        description: Access forbidden
202
        description: Access forbidden
203
        schema:
203
        schema:
204
          $ref: ../definitions.yaml#/error
204
          $ref: "../swagger.yaml#/definitions/error"
205
      "404":
205
      "404":
206
        description: City not found
206
        description: City not found
207
        schema:
207
        schema:
208
          $ref: ../definitions.yaml#/error
208
          $ref: "../swagger.yaml#/definitions/error"
209
      "500":
209
      "500":
210
        description: Internal error
210
        description: Internal error
211
        schema:
211
        schema:
212
          $ref: ../definitions.yaml#/error
212
          $ref: "../swagger.yaml#/definitions/error"
213
      "503":
213
      "503":
214
        description: Under maintenance
214
        description: Under maintenance
215
        schema:
215
        schema:
216
          $ref: ../definitions.yaml#/error
216
          $ref: "../swagger.yaml#/definitions/error"
217
    x-koha-authorization:
217
    x-koha-authorization:
218
      permissions:
218
      permissions:
219
        parameters: manage_cities
219
        parameters: manage_cities
(-)a/api/v1/swagger/paths/clubs.yaml (-9 / +9 lines)
Lines 7-13 Link Here
7
      - clubs
7
      - clubs
8
    summary: Add a club hold
8
    summary: Add a club hold
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/club_id_pp
10
      - $ref: "../swagger.yaml#/parameters/club_id_pp"
11
      - name: body
11
      - name: body
12
        in: body
12
        in: body
13
        description: A JSON object containing informations about the new hold
13
        description: A JSON object containing informations about the new hold
Lines 59-96 Link Here
59
      "201":
59
      "201":
60
        description: Created club hold
60
        description: Created club hold
61
        schema:
61
        schema:
62
          $ref: ../definitions/club_hold.yaml
62
          $ref: "../definitions/club_hold.yaml"
63
      "400":
63
      "400":
64
        description: Missing or wrong parameters
64
        description: Missing or wrong parameters
65
        schema:
65
        schema:
66
          $ref: ../definitions.yaml#/error
66
          $ref: "../swagger.yaml#/definitions/error"
67
      "401":
67
      "401":
68
        description: Authentication required
68
        description: Authentication required
69
        schema:
69
        schema:
70
          $ref: ../definitions.yaml#/error
70
          $ref: "../swagger.yaml#/definitions/error"
71
      "403":
71
      "403":
72
        description: Hold not allowed
72
        description: Hold not allowed
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/error
74
          $ref: "../swagger.yaml#/definitions/error"
75
      "404":
75
      "404":
76
        description: Club not found
76
        description: Club not found
77
        schema:
77
        schema:
78
          $ref: ../definitions.yaml#/error
78
          $ref: "../swagger.yaml#/definitions/error"
79
      "409":
79
      "409":
80
        description: Hold not allowed
80
        description: Hold not allowed
81
        schema:
81
        schema:
82
          $ref: ../definitions.yaml#/error
82
          $ref: "../swagger.yaml#/definitions/error"
83
      "500":
83
      "500":
84
        description: |
84
        description: |
85
          Internal server error. Possible `error_code` attribute values:
85
          Internal server error. Possible `error_code` attribute values:
86
86
87
          * `internal_server_error`
87
          * `internal_server_error`
88
        schema:
88
        schema:
89
          $ref: ../definitions.yaml#/error
89
          $ref: "../swagger.yaml#/definitions/error"
90
      "503":
90
      "503":
91
        description: Under maintenance
91
        description: Under maintenance
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/error
93
          $ref: "../swagger.yaml#/definitions/error"
94
    x-koha-authorization:
94
    x-koha-authorization:
95
      permissions:
95
      permissions:
96
        reserveforothers: "1"
96
        reserveforothers: "1"
(-)a/api/v1/swagger/paths/config_smtp_servers.yaml (-38 / +38 lines)
Lines 9-43 Link Here
9
    produces:
9
    produces:
10
      - application/json
10
      - application/json
11
    parameters:
11
    parameters:
12
      - $ref: ../parameters.yaml#/match
12
      - $ref: "../swagger.yaml#/parameters/match"
13
      - $ref: ../parameters.yaml#/order_by
13
      - $ref: "../swagger.yaml#/parameters/order_by"
14
      - $ref: ../parameters.yaml#/page
14
      - $ref: "../swagger.yaml#/parameters/page"
15
      - $ref: ../parameters.yaml#/per_page
15
      - $ref: "../swagger.yaml#/parameters/per_page"
16
      - $ref: ../parameters.yaml#/q_param
16
      - $ref: "../swagger.yaml#/parameters/q_param"
17
      - $ref: ../parameters.yaml#/q_body
17
      - $ref: "../swagger.yaml#/parameters/q_body"
18
      - $ref: ../parameters.yaml#/q_header
18
      - $ref: "../swagger.yaml#/parameters/q_header"
19
    responses:
19
    responses:
20
      "200":
20
      "200":
21
        description: A list of SMTP servers
21
        description: A list of SMTP servers
22
        schema:
22
        schema:
23
          type: array
23
          type: array
24
          items:
24
          items:
25
            $ref: ../definitions.yaml#/smtp_server
25
            $ref: "../swagger.yaml#/definitions/smtp_server"
26
      "403":
26
      "403":
27
        description: Access forbidden
27
        description: Access forbidden
28
        schema:
28
        schema:
29
          $ref: ../definitions.yaml#/error
29
          $ref: "../swagger.yaml#/definitions/error"
30
      "500":
30
      "500":
31
        description: |
31
        description: |
32
          Internal server error. Possible `error_code` attribute values:
32
          Internal server error. Possible `error_code` attribute values:
33
33
34
          * `internal_server_error`
34
          * `internal_server_error`
35
        schema:
35
        schema:
36
          $ref: ../definitions.yaml#/error
36
          $ref: "../swagger.yaml#/definitions/error"
37
      "503":
37
      "503":
38
        description: Under maintenance
38
        description: Under maintenance
39
        schema:
39
        schema:
40
          $ref: ../definitions.yaml#/error
40
          $ref: "../swagger.yaml#/definitions/error"
41
    x-koha-authorization:
41
    x-koha-authorization:
42
      permissions:
42
      permissions:
43
        parameters: manage_smtp_servers
43
        parameters: manage_smtp_servers
Lines 53-89 Link Here
53
        description: A JSON object representing a new SMTP server configuration
53
        description: A JSON object representing a new SMTP server configuration
54
        required: true
54
        required: true
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/smtp_server
56
          $ref: "../swagger.yaml#/definitions/smtp_server"
57
    produces:
57
    produces:
58
      - application/json
58
      - application/json
59
    responses:
59
    responses:
60
      "201":
60
      "201":
61
        description: An SMTP server object
61
        description: An SMTP server object
62
        schema:
62
        schema:
63
          $ref: ../definitions.yaml#/smtp_server
63
          $ref: "../swagger.yaml#/definitions/smtp_server"
64
      "401":
64
      "401":
65
        description: Authentication required
65
        description: Authentication required
66
        schema:
66
        schema:
67
          $ref: ../definitions.yaml#/error
67
          $ref: "../swagger.yaml#/definitions/error"
68
      "403":
68
      "403":
69
        description: Access forbidden
69
        description: Access forbidden
70
        schema:
70
        schema:
71
          $ref: ../definitions.yaml#/error
71
          $ref: "../swagger.yaml#/definitions/error"
72
      "409":
72
      "409":
73
        description: Conflict in creating resource
73
        description: Conflict in creating resource
74
        schema:
74
        schema:
75
          $ref: ../definitions.yaml#/error
75
          $ref: "../swagger.yaml#/definitions/error"
76
      "500":
76
      "500":
77
        description: |
77
        description: |
78
          Internal server error. Possible `error_code` attribute values:
78
          Internal server error. Possible `error_code` attribute values:
79
79
80
          * `internal_server_error`
80
          * `internal_server_error`
81
        schema:
81
        schema:
82
          $ref: ../definitions.yaml#/error
82
          $ref: "../swagger.yaml#/definitions/error"
83
      "503":
83
      "503":
84
        description: Under maintenance
84
        description: Under maintenance
85
        schema:
85
        schema:
86
          $ref: ../definitions.yaml#/error
86
          $ref: "../swagger.yaml#/definitions/error"
87
    x-koha-authorization:
87
    x-koha-authorization:
88
      permissions:
88
      permissions:
89
        parameters: manage_smtp_servers
89
        parameters: manage_smtp_servers
Lines 95-127 Link Here
95
      - smtp_servers
95
      - smtp_servers
96
    summary: Get SMTP server
96
    summary: Get SMTP server
97
    parameters:
97
    parameters:
98
      - $ref: ../parameters.yaml#/smtp_server_id_pp
98
      - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp"
99
    produces:
99
    produces:
100
      - application/json
100
      - application/json
101
    responses:
101
    responses:
102
      "200":
102
      "200":
103
        description: An SMTP server object
103
        description: An SMTP server object
104
        schema:
104
        schema:
105
          $ref: ../definitions.yaml#/smtp_server
105
          $ref: "../swagger.yaml#/definitions/smtp_server"
106
      "404":
106
      "404":
107
        description: Object not found
107
        description: Object not found
108
        schema:
108
        schema:
109
          $ref: ../definitions.yaml#/error
109
          $ref: "../swagger.yaml#/definitions/error"
110
      "409":
110
      "409":
111
        description: Conflict updating resource
111
        description: Conflict updating resource
112
        schema:
112
        schema:
113
          $ref: ../definitions.yaml#/error
113
          $ref: "../swagger.yaml#/definitions/error"
114
      "500":
114
      "500":
115
        description: |
115
        description: |
116
          Internal server error. Possible `error_code` attribute values:
116
          Internal server error. Possible `error_code` attribute values:
117
117
118
          * `internal_server_error`
118
          * `internal_server_error`
119
        schema:
119
        schema:
120
          $ref: ../definitions.yaml#/error
120
          $ref: "../swagger.yaml#/definitions/error"
121
      "503":
121
      "503":
122
        description: Under maintenance
122
        description: Under maintenance
123
        schema:
123
        schema:
124
          $ref: ../definitions.yaml#/error
124
          $ref: "../swagger.yaml#/definitions/error"
125
    x-koha-authorization:
125
    x-koha-authorization:
126
      permissions:
126
      permissions:
127
        parameters: manage_smtp_servers
127
        parameters: manage_smtp_servers
Lines 132-174 Link Here
132
      - smtp_servers
132
      - smtp_servers
133
    summary: Update SMTP server
133
    summary: Update SMTP server
134
    parameters:
134
    parameters:
135
      - $ref: ../parameters.yaml#/smtp_server_id_pp
135
      - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp"
136
      - name: body
136
      - name: body
137
        in: body
137
        in: body
138
        description: An SMTP server object
138
        description: An SMTP server object
139
        required: true
139
        required: true
140
        schema:
140
        schema:
141
          $ref: ../definitions.yaml#/smtp_server
141
          $ref: "../swagger.yaml#/definitions/smtp_server"
142
    produces:
142
    produces:
143
      - application/json
143
      - application/json
144
    responses:
144
    responses:
145
      "200":
145
      "200":
146
        description: An SMTP server object
146
        description: An SMTP server object
147
        schema:
147
        schema:
148
          $ref: ../definitions.yaml#/smtp_server
148
          $ref: "../swagger.yaml#/definitions/smtp_server"
149
      "401":
149
      "401":
150
        description: Authentication required
150
        description: Authentication required
151
        schema:
151
        schema:
152
          $ref: ../definitions.yaml#/error
152
          $ref: "../swagger.yaml#/definitions/error"
153
      "403":
153
      "403":
154
        description: Access forbidden
154
        description: Access forbidden
155
        schema:
155
        schema:
156
          $ref: ../definitions.yaml#/error
156
          $ref: "../swagger.yaml#/definitions/error"
157
      "404":
157
      "404":
158
        description: Object not found
158
        description: Object not found
159
        schema:
159
        schema:
160
          $ref: ../definitions.yaml#/error
160
          $ref: "../swagger.yaml#/definitions/error"
161
      "500":
161
      "500":
162
        description: |
162
        description: |
163
          Internal server error. Possible `error_code` attribute values:
163
          Internal server error. Possible `error_code` attribute values:
164
164
165
          * `internal_server_error`
165
          * `internal_server_error`
166
        schema:
166
        schema:
167
          $ref: ../definitions.yaml#/error
167
          $ref: "../swagger.yaml#/definitions/error"
168
      "503":
168
      "503":
169
        description: Under maintenance
169
        description: Under maintenance
170
        schema:
170
        schema:
171
          $ref: ../definitions.yaml#/error
171
          $ref: "../swagger.yaml#/definitions/error"
172
    x-koha-authorization:
172
    x-koha-authorization:
173
      permissions:
173
      permissions:
174
        parameters: manage_smtp_servers
174
        parameters: manage_smtp_servers
Lines 179-185 Link Here
179
      - smtp_servers
179
      - smtp_servers
180
    summary: Delete SMTP server
180
    summary: Delete SMTP server
181
    parameters:
181
    parameters:
182
      - $ref: ../parameters.yaml#/smtp_server_id_pp
182
      - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp"
183
    produces:
183
    produces:
184
      - application/json
184
      - application/json
185
    responses:
185
    responses:
Lines 188-213 Link Here
188
      "401":
188
      "401":
189
        description: Authentication required
189
        description: Authentication required
190
        schema:
190
        schema:
191
          $ref: ../definitions.yaml#/error
191
          $ref: "../swagger.yaml#/definitions/error"
192
      "403":
192
      "403":
193
        description: Access forbidden
193
        description: Access forbidden
194
        schema:
194
        schema:
195
          $ref: ../definitions.yaml#/error
195
          $ref: "../swagger.yaml#/definitions/error"
196
      "404":
196
      "404":
197
        description: Object not found
197
        description: Object not found
198
        schema:
198
        schema:
199
          $ref: ../definitions.yaml#/error
199
          $ref: "../swagger.yaml#/definitions/error"
200
      "500":
200
      "500":
201
        description: |
201
        description: |
202
          Internal server error. Possible `error_code` attribute values:
202
          Internal server error. Possible `error_code` attribute values:
203
203
204
          * `internal_server_error`
204
          * `internal_server_error`
205
        schema:
205
        schema:
206
          $ref: ../definitions.yaml#/error
206
          $ref: "../swagger.yaml#/definitions/error"
207
      "503":
207
      "503":
208
        description: Under maintenance
208
        description: Under maintenance
209
        schema:
209
        schema:
210
          $ref: ../definitions.yaml#/error
210
          $ref: "../swagger.yaml#/definitions/error"
211
    x-koha-authorization:
211
    x-koha-authorization:
212
      permissions:
212
      permissions:
213
        parameters: manage_smtp_servers
213
        parameters: manage_smtp_servers
(-)a/api/v1/swagger/paths/holds.yaml (-86 / +86 lines)
Lines 77-119 Link Here
77
        in: query
77
        in: query
78
        description: Non priority hold
78
        description: Non priority hold
79
        type: boolean
79
        type: boolean
80
      - $ref: ../parameters.yaml#/match
80
      - $ref: "../swagger.yaml#/parameters/match"
81
      - $ref: ../parameters.yaml#/order_by
81
      - $ref: "../swagger.yaml#/parameters/order_by"
82
      - $ref: ../parameters.yaml#/page
82
      - $ref: "../swagger.yaml#/parameters/page"
83
      - $ref: ../parameters.yaml#/per_page
83
      - $ref: "../swagger.yaml#/parameters/per_page"
84
      - $ref: ../parameters.yaml#/q_param
84
      - $ref: "../swagger.yaml#/parameters/q_param"
85
      - $ref: ../parameters.yaml#/q_body
85
      - $ref: "../swagger.yaml#/parameters/q_body"
86
      - $ref: ../parameters.yaml#/q_header
86
      - $ref: "../swagger.yaml#/parameters/q_header"
87
    produces:
87
    produces:
88
      - application/json
88
      - application/json
89
    responses:
89
    responses:
90
      "200":
90
      "200":
91
        description: A list of holds
91
        description: A list of holds
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/holds
93
          $ref: "../swagger.yaml#/definitions/holds"
94
      "401":
94
      "401":
95
        description: Authentication required
95
        description: Authentication required
96
        schema:
96
        schema:
97
          $ref: ../definitions.yaml#/error
97
          $ref: "../swagger.yaml#/definitions/error"
98
      "403":
98
      "403":
99
        description: Hold not allowed
99
        description: Hold not allowed
100
        schema:
100
        schema:
101
          $ref: ../definitions.yaml#/error
101
          $ref: "../swagger.yaml#/definitions/error"
102
      "404":
102
      "404":
103
        description: Borrower not found
103
        description: Borrower not found
104
        schema:
104
        schema:
105
          $ref: ../definitions.yaml#/error
105
          $ref: "../swagger.yaml#/definitions/error"
106
      "500":
106
      "500":
107
        description: |
107
        description: |
108
          Internal server error. Possible `error_code` attribute values:
108
          Internal server error. Possible `error_code` attribute values:
109
109
110
          * `internal_server_error`
110
          * `internal_server_error`
111
        schema:
111
        schema:
112
          $ref: ../definitions.yaml#/error
112
          $ref: "../swagger.yaml#/definitions/error"
113
      "503":
113
      "503":
114
        description: Under maintenance
114
        description: Under maintenance
115
        schema:
115
        schema:
116
          $ref: ../definitions.yaml#/error
116
          $ref: "../swagger.yaml#/definitions/error"
117
    x-koha-authorization:
117
    x-koha-authorization:
118
      permissions:
118
      permissions:
119
        borrowers: edit_borrowers
119
        borrowers: edit_borrowers
Lines 191-224 Link Here
191
      "201":
191
      "201":
192
        description: Created hold
192
        description: Created hold
193
        schema:
193
        schema:
194
          $ref: ../definitions.yaml#/hold
194
          $ref: "../swagger.yaml#/definitions/hold"
195
      "400":
195
      "400":
196
        description: Missing or wrong parameters
196
        description: Missing or wrong parameters
197
        schema:
197
        schema:
198
          $ref: ../definitions.yaml#/error
198
          $ref: "../swagger.yaml#/definitions/error"
199
      "401":
199
      "401":
200
        description: Authentication required
200
        description: Authentication required
201
        schema:
201
        schema:
202
          $ref: ../definitions.yaml#/error
202
          $ref: "../swagger.yaml#/definitions/error"
203
      "403":
203
      "403":
204
        description: Hold not allowed
204
        description: Hold not allowed
205
        schema:
205
        schema:
206
          $ref: ../definitions.yaml#/error
206
          $ref: "../swagger.yaml#/definitions/error"
207
      "404":
207
      "404":
208
        description: Borrower not found
208
        description: Borrower not found
209
        schema:
209
        schema:
210
          $ref: ../definitions.yaml#/error
210
          $ref: "../swagger.yaml#/definitions/error"
211
      "500":
211
      "500":
212
        description: |
212
        description: |
213
          Internal server error. Possible `error_code` attribute values:
213
          Internal server error. Possible `error_code` attribute values:
214
214
215
          * `internal_server_error`
215
          * `internal_server_error`
216
        schema:
216
        schema:
217
          $ref: ../definitions.yaml#/error
217
          $ref: "../swagger.yaml#/definitions/error"
218
      "503":
218
      "503":
219
        description: Under maintenance
219
        description: Under maintenance
220
        schema:
220
        schema:
221
          $ref: ../definitions.yaml#/error
221
          $ref: "../swagger.yaml#/definitions/error"
222
    x-koha-authorization:
222
    x-koha-authorization:
223
      permissions:
223
      permissions:
224
        reserveforothers: "1"
224
        reserveforothers: "1"
Lines 230-236 Link Here
230
      - holds
230
      - holds
231
    summary: Update hold
231
    summary: Update hold
232
    parameters:
232
    parameters:
233
      - $ref: ../parameters.yaml#/hold_id_pp
233
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
234
      - name: body
234
      - name: body
235
        in: body
235
        in: body
236
        description: A JSON object containing fields to modify
236
        description: A JSON object containing fields to modify
Lines 258-291 Link Here
258
      "200":
258
      "200":
259
        description: Updated hold
259
        description: Updated hold
260
        schema:
260
        schema:
261
          $ref: ../definitions.yaml#/hold
261
          $ref: "../swagger.yaml#/definitions/hold"
262
      "400":
262
      "400":
263
        description: Missing or wrong parameters
263
        description: Missing or wrong parameters
264
        schema:
264
        schema:
265
          $ref: ../definitions.yaml#/error
265
          $ref: "../swagger.yaml#/definitions/error"
266
      "401":
266
      "401":
267
        description: Authentication required
267
        description: Authentication required
268
        schema:
268
        schema:
269
          $ref: ../definitions.yaml#/error
269
          $ref: "../swagger.yaml#/definitions/error"
270
      "403":
270
      "403":
271
        description: Hold not allowed
271
        description: Hold not allowed
272
        schema:
272
        schema:
273
          $ref: ../definitions.yaml#/error
273
          $ref: "../swagger.yaml#/definitions/error"
274
      "404":
274
      "404":
275
        description: Hold not found
275
        description: Hold not found
276
        schema:
276
        schema:
277
          $ref: ../definitions.yaml#/error
277
          $ref: "../swagger.yaml#/definitions/error"
278
      "500":
278
      "500":
279
        description: |
279
        description: |
280
          Internal server error. Possible `error_code` attribute values:
280
          Internal server error. Possible `error_code` attribute values:
281
281
282
          * `internal_server_error`
282
          * `internal_server_error`
283
        schema:
283
        schema:
284
          $ref: ../definitions.yaml#/error
284
          $ref: "../swagger.yaml#/definitions/error"
285
      "503":
285
      "503":
286
        description: Under maintenance
286
        description: Under maintenance
287
        schema:
287
        schema:
288
          $ref: ../definitions.yaml#/error
288
          $ref: "../swagger.yaml#/definitions/error"
289
    x-koha-authorization:
289
    x-koha-authorization:
290
      permissions:
290
      permissions:
291
        reserveforothers: "1"
291
        reserveforothers: "1"
Lines 298-304 Link Here
298
    description: This route is being deprecated and will be removed in future releases.
298
    description: This route is being deprecated and will be removed in future releases.
299
      Please migrate your project to use PATCH /holds/{hold_id} instead.
299
      Please migrate your project to use PATCH /holds/{hold_id} instead.
300
    parameters:
300
    parameters:
301
      - $ref: ../parameters.yaml#/hold_id_pp
301
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
302
      - name: body
302
      - name: body
303
        in: body
303
        in: body
304
        description: A JSON object containing fields to modify
304
        description: A JSON object containing fields to modify
Lines 326-359 Link Here
326
      "200":
326
      "200":
327
        description: Updated hold
327
        description: Updated hold
328
        schema:
328
        schema:
329
          $ref: ../definitions.yaml#/hold
329
          $ref: "../swagger.yaml#/definitions/hold"
330
      "400":
330
      "400":
331
        description: Missing or wrong parameters
331
        description: Missing or wrong parameters
332
        schema:
332
        schema:
333
          $ref: ../definitions.yaml#/error
333
          $ref: "../swagger.yaml#/definitions/error"
334
      "401":
334
      "401":
335
        description: Authentication required
335
        description: Authentication required
336
        schema:
336
        schema:
337
          $ref: ../definitions.yaml#/error
337
          $ref: "../swagger.yaml#/definitions/error"
338
      "403":
338
      "403":
339
        description: Hold not allowed
339
        description: Hold not allowed
340
        schema:
340
        schema:
341
          $ref: ../definitions.yaml#/error
341
          $ref: "../swagger.yaml#/definitions/error"
342
      "404":
342
      "404":
343
        description: Hold not found
343
        description: Hold not found
344
        schema:
344
        schema:
345
          $ref: ../definitions.yaml#/error
345
          $ref: "../swagger.yaml#/definitions/error"
346
      "500":
346
      "500":
347
        description: |
347
        description: |
348
          Internal server error. Possible `error_code` attribute values:
348
          Internal server error. Possible `error_code` attribute values:
349
349
350
          * `internal_server_error`
350
          * `internal_server_error`
351
        schema:
351
        schema:
352
          $ref: ../definitions.yaml#/error
352
          $ref: "../swagger.yaml#/definitions/error"
353
      "503":
353
      "503":
354
        description: Under maintenance
354
        description: Under maintenance
355
        schema:
355
        schema:
356
          $ref: ../definitions.yaml#/error
356
          $ref: "../swagger.yaml#/definitions/error"
357
    x-koha-authorization:
357
    x-koha-authorization:
358
      permissions:
358
      permissions:
359
        reserveforothers: "1"
359
        reserveforothers: "1"
Lines 364-370 Link Here
364
      - holds
364
      - holds
365
    summary: Cancel hold
365
    summary: Cancel hold
366
    parameters:
366
    parameters:
367
      - $ref: ../parameters.yaml#/hold_id_pp
367
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
368
    produces:
368
    produces:
369
      - application/json
369
      - application/json
370
    responses:
370
    responses:
Lines 373-398 Link Here
373
      "401":
373
      "401":
374
        description: Authentication required
374
        description: Authentication required
375
        schema:
375
        schema:
376
          $ref: ../definitions.yaml#/error
376
          $ref: "../swagger.yaml#/definitions/error"
377
      "403":
377
      "403":
378
        description: Hold not allowed
378
        description: Hold not allowed
379
        schema:
379
        schema:
380
          $ref: ../definitions.yaml#/error
380
          $ref: "../swagger.yaml#/definitions/error"
381
      "404":
381
      "404":
382
        description: Hold not found
382
        description: Hold not found
383
        schema:
383
        schema:
384
          $ref: ../definitions.yaml#/error
384
          $ref: "../swagger.yaml#/definitions/error"
385
      "500":
385
      "500":
386
        description: |
386
        description: |
387
          Internal server error. Possible `error_code` attribute values:
387
          Internal server error. Possible `error_code` attribute values:
388
388
389
          * `internal_server_error`
389
          * `internal_server_error`
390
        schema:
390
        schema:
391
          $ref: ../definitions.yaml#/error
391
          $ref: "../swagger.yaml#/definitions/error"
392
      "503":
392
      "503":
393
        description: Under maintenance
393
        description: Under maintenance
394
        schema:
394
        schema:
395
          $ref: ../definitions.yaml#/error
395
          $ref: "../swagger.yaml#/definitions/error"
396
    x-koha-authorization:
396
    x-koha-authorization:
397
      permissions:
397
      permissions:
398
        reserveforothers: "1"
398
        reserveforothers: "1"
Lines 404-410 Link Here
404
      - holds
404
      - holds
405
    summary: Update priority for the hold
405
    summary: Update priority for the hold
406
    parameters:
406
    parameters:
407
      - $ref: ../parameters.yaml#/hold_id_pp
407
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
408
      - name: body
408
      - name: body
409
        in: body
409
        in: body
410
        description: An integer representing the new priority to be set for the hold
410
        description: An integer representing the new priority to be set for the hold
Lines 421-450 Link Here
421
      "401":
421
      "401":
422
        description: Authentication required
422
        description: Authentication required
423
        schema:
423
        schema:
424
          $ref: ../definitions.yaml#/error
424
          $ref: "../swagger.yaml#/definitions/error"
425
      "403":
425
      "403":
426
        description: Access forbidden
426
        description: Access forbidden
427
        schema:
427
        schema:
428
          $ref: ../definitions.yaml#/error
428
          $ref: "../swagger.yaml#/definitions/error"
429
      "404":
429
      "404":
430
        description: Biblio not found
430
        description: Biblio not found
431
        schema:
431
        schema:
432
          $ref: ../definitions.yaml#/error
432
          $ref: "../swagger.yaml#/definitions/error"
433
      "409":
433
      "409":
434
        description: Unable to perform action on biblio
434
        description: Unable to perform action on biblio
435
        schema:
435
        schema:
436
          $ref: ../definitions.yaml#/error
436
          $ref: "../swagger.yaml#/definitions/error"
437
      "500":
437
      "500":
438
        description: |
438
        description: |
439
          Internal server error. Possible `error_code` attribute values:
439
          Internal server error. Possible `error_code` attribute values:
440
440
441
          * `internal_server_error`
441
          * `internal_server_error`
442
        schema:
442
        schema:
443
          $ref: ../definitions.yaml#/error
443
          $ref: "../swagger.yaml#/definitions/error"
444
      "503":
444
      "503":
445
        description: Under maintenance
445
        description: Under maintenance
446
        schema:
446
        schema:
447
          $ref: ../definitions.yaml#/error
447
          $ref: "../swagger.yaml#/definitions/error"
448
    x-koha-authorization:
448
    x-koha-authorization:
449
      permissions:
449
      permissions:
450
        reserveforothers: modify_holds_priority
450
        reserveforothers: modify_holds_priority
Lines 456-462 Link Here
456
      - holds
456
      - holds
457
    summary: Suspend the hold
457
    summary: Suspend the hold
458
    parameters:
458
    parameters:
459
      - $ref: ../parameters.yaml#/hold_id_pp
459
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
460
      - name: body
460
      - name: body
461
        in: body
461
        in: body
462
        description: A JSON object containing fields to modify
462
        description: A JSON object containing fields to modify
Lines 479-508 Link Here
479
      "400":
479
      "400":
480
        description: Missing or wrong parameters
480
        description: Missing or wrong parameters
481
        schema:
481
        schema:
482
          $ref: ../definitions.yaml#/error
482
          $ref: "../swagger.yaml#/definitions/error"
483
      "401":
483
      "401":
484
        description: Authentication required
484
        description: Authentication required
485
        schema:
485
        schema:
486
          $ref: ../definitions.yaml#/error
486
          $ref: "../swagger.yaml#/definitions/error"
487
      "403":
487
      "403":
488
        description: Hold not allowed
488
        description: Hold not allowed
489
        schema:
489
        schema:
490
          $ref: ../definitions.yaml#/error
490
          $ref: "../swagger.yaml#/definitions/error"
491
      "404":
491
      "404":
492
        description: Hold not found
492
        description: Hold not found
493
        schema:
493
        schema:
494
          $ref: ../definitions.yaml#/error
494
          $ref: "../swagger.yaml#/definitions/error"
495
      "500":
495
      "500":
496
        description: |
496
        description: |
497
          Internal server error. Possible `error_code` attribute values:
497
          Internal server error. Possible `error_code` attribute values:
498
498
499
          * `internal_server_error`
499
          * `internal_server_error`
500
        schema:
500
        schema:
501
          $ref: ../definitions.yaml#/error
501
          $ref: "../swagger.yaml#/definitions/error"
502
      "503":
502
      "503":
503
        description: Under maintenance
503
        description: Under maintenance
504
        schema:
504
        schema:
505
          $ref: ../definitions.yaml#/error
505
          $ref: "../swagger.yaml#/definitions/error"
506
    x-koha-authorization:
506
    x-koha-authorization:
507
      permissions:
507
      permissions:
508
        reserveforothers: "1"
508
        reserveforothers: "1"
Lines 513-519 Link Here
513
      - holds
513
      - holds
514
    summary: Resume hold
514
    summary: Resume hold
515
    parameters:
515
    parameters:
516
      - $ref: ../parameters.yaml#/hold_id_pp
516
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
517
    consumes:
517
    consumes:
518
      - application/json
518
      - application/json
519
    produces:
519
    produces:
Lines 524-553 Link Here
524
      "400":
524
      "400":
525
        description: Missing or wrong parameters
525
        description: Missing or wrong parameters
526
        schema:
526
        schema:
527
          $ref: ../definitions.yaml#/error
527
          $ref: "../swagger.yaml#/definitions/error"
528
      "401":
528
      "401":
529
        description: Authentication required
529
        description: Authentication required
530
        schema:
530
        schema:
531
          $ref: ../definitions.yaml#/error
531
          $ref: "../swagger.yaml#/definitions/error"
532
      "403":
532
      "403":
533
        description: Hold not allowed
533
        description: Hold not allowed
534
        schema:
534
        schema:
535
          $ref: ../definitions.yaml#/error
535
          $ref: "../swagger.yaml#/definitions/error"
536
      "404":
536
      "404":
537
        description: Hold not found
537
        description: Hold not found
538
        schema:
538
        schema:
539
          $ref: ../definitions.yaml#/error
539
          $ref: "../swagger.yaml#/definitions/error"
540
      "500":
540
      "500":
541
        description: |
541
        description: |
542
          Internal server error. Possible `error_code` attribute values:
542
          Internal server error. Possible `error_code` attribute values:
543
543
544
          * `internal_server_error`
544
          * `internal_server_error`
545
        schema:
545
        schema:
546
          $ref: ../definitions.yaml#/error
546
          $ref: "../swagger.yaml#/definitions/error"
547
      "503":
547
      "503":
548
        description: Under maintenance
548
        description: Under maintenance
549
        schema:
549
        schema:
550
          $ref: ../definitions.yaml#/error
550
          $ref: "../swagger.yaml#/definitions/error"
551
    x-koha-authorization:
551
    x-koha-authorization:
552
      permissions:
552
      permissions:
553
        reserveforothers: "1"
553
        reserveforothers: "1"
Lines 564-577 Link Here
564
        in: header
564
        in: header
565
        type: string
565
        type: string
566
        required: false
566
        required: false
567
      - $ref: ../parameters.yaml#/hold_id_pp
567
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
568
      - $ref: ../parameters.yaml#/match
568
      - $ref: "../swagger.yaml#/parameters/match"
569
      - $ref: ../parameters.yaml#/order_by
569
      - $ref: "../swagger.yaml#/parameters/order_by"
570
      - $ref: ../parameters.yaml#/page
570
      - $ref: "../swagger.yaml#/parameters/page"
571
      - $ref: ../parameters.yaml#/per_page
571
      - $ref: "../swagger.yaml#/parameters/per_page"
572
      - $ref: ../parameters.yaml#/q_param
572
      - $ref: "../swagger.yaml#/parameters/q_param"
573
      - $ref: ../parameters.yaml#/q_body
573
      - $ref: "../swagger.yaml#/parameters/q_body"
574
      - $ref: ../parameters.yaml#/q_header
574
      - $ref: "../swagger.yaml#/parameters/q_header"
575
    produces:
575
    produces:
576
      - application/json
576
      - application/json
577
    responses:
577
    responses:
Lines 580-613 Link Here
580
        schema:
580
        schema:
581
          type: array
581
          type: array
582
          items:
582
          items:
583
            $ref: ../definitions.yaml#/library
583
            $ref: "../swagger.yaml#/definitions/library"
584
      "400":
584
      "400":
585
        description: Missing or wrong parameters
585
        description: Missing or wrong parameters
586
        schema:
586
        schema:
587
          $ref: ../definitions.yaml#/error
587
          $ref: "../swagger.yaml#/definitions/error"
588
      "401":
588
      "401":
589
        description: Authentication required
589
        description: Authentication required
590
        schema:
590
        schema:
591
          $ref: ../definitions.yaml#/error
591
          $ref: "../swagger.yaml#/definitions/error"
592
      "403":
592
      "403":
593
        description: Hold pickup location list not allowed
593
        description: Hold pickup location list not allowed
594
        schema:
594
        schema:
595
          $ref: ../definitions.yaml#/error
595
          $ref: "../swagger.yaml#/definitions/error"
596
      "404":
596
      "404":
597
        description: Hold not found
597
        description: Hold not found
598
        schema:
598
        schema:
599
          $ref: ../definitions.yaml#/error
599
          $ref: "../swagger.yaml#/definitions/error"
600
      "500":
600
      "500":
601
        description: |
601
        description: |
602
          Internal server error. Possible `error_code` attribute values:
602
          Internal server error. Possible `error_code` attribute values:
603
603
604
          * `internal_server_error`
604
          * `internal_server_error`
605
        schema:
605
        schema:
606
          $ref: ../definitions.yaml#/error
606
          $ref: "../swagger.yaml#/definitions/error"
607
      "503":
607
      "503":
608
        description: Under maintenance
608
        description: Under maintenance
609
        schema:
609
        schema:
610
          $ref: ../definitions.yaml#/error
610
          $ref: "../swagger.yaml#/definitions/error"
611
    x-koha-authorization:
611
    x-koha-authorization:
612
      permissions:
612
      permissions:
613
        reserveforothers: place_holds
613
        reserveforothers: place_holds
Lines 620-626 Link Here
620
    summary: Update pickup location for the hold
620
    summary: Update pickup location for the hold
621
    description: Set a new pickup location for the hold
621
    description: Set a new pickup location for the hold
622
    parameters:
622
    parameters:
623
      - $ref: ../parameters.yaml#/hold_id_pp
623
      - $ref: "../swagger.yaml#/parameters/hold_id_pp"
624
      - name: body
624
      - name: body
625
        in: body
625
        in: body
626
        description: Pickup location
626
        description: Pickup location
Lines 647-677 Link Here
647
      "400":
647
      "400":
648
        description: Missing or wrong parameters
648
        description: Missing or wrong parameters
649
        schema:
649
        schema:
650
          $ref: ../definitions.yaml#/error
650
          $ref: "../swagger.yaml#/definitions/error"
651
      "401":
651
      "401":
652
        description: Authentication required
652
        description: Authentication required
653
        schema:
653
        schema:
654
          $ref: ../definitions.yaml#/error
654
          $ref: "../swagger.yaml#/definitions/error"
655
      "403":
655
      "403":
656
        description: Access forbidden
656
        description: Access forbidden
657
        schema:
657
        schema:
658
          $ref: ../definitions.yaml#/error
658
          $ref: "../swagger.yaml#/definitions/error"
659
      "404":
659
      "404":
660
        description: Hold not found
660
        description: Hold not found
661
        schema:
661
        schema:
662
          $ref: ../definitions.yaml#/error
662
          $ref: "../swagger.yaml#/definitions/error"
663
      "409":
663
      "409":
664
        description: Unable to perform action on hold
664
        description: Unable to perform action on hold
665
        schema:
665
        schema:
666
          $ref: ../definitions.yaml#/error
666
          $ref: "../swagger.yaml#/definitions/error"
667
      "500":
667
      "500":
668
        description: Internal error
668
        description: Internal error
669
        schema:
669
        schema:
670
          $ref: ../definitions.yaml#/error
670
          $ref: "../swagger.yaml#/definitions/error"
671
      "503":
671
      "503":
672
        description: Under maintenance
672
        description: Under maintenance
673
        schema:
673
        schema:
674
          $ref: ../definitions.yaml#/error
674
          $ref: "../swagger.yaml#/definitions/error"
675
    x-koha-authorization:
675
    x-koha-authorization:
676
      permissions:
676
      permissions:
677
        reserveforothers: place_holds
677
        reserveforothers: place_holds
(-)a/api/v1/swagger/paths/ill_backends.yaml (-12 / +12 lines)
Lines 13-42 Link Here
13
      "200":
13
      "200":
14
        description: A list of ILL backends
14
        description: A list of ILL backends
15
        schema:
15
        schema:
16
          $ref: ../definitions.yaml#/ill_backends
16
          $ref: "../swagger.yaml#/definitions/ill_backends"
17
      "401":
17
      "401":
18
        description: Authentication required
18
        description: Authentication required
19
        schema:
19
        schema:
20
          $ref: ../definitions.yaml#/error
20
          $ref: "../swagger.yaml#/definitions/error"
21
      "403":
21
      "403":
22
        description: Access forbidden
22
        description: Access forbidden
23
        schema:
23
        schema:
24
          $ref: ../definitions.yaml#/error
24
          $ref: "../swagger.yaml#/definitions/error"
25
      "404":
25
      "404":
26
        description: ILL backends not found
26
        description: ILL backends not found
27
        schema:
27
        schema:
28
          $ref: ../definitions.yaml#/error
28
          $ref: "../swagger.yaml#/definitions/error"
29
      "500":
29
      "500":
30
        description: |
30
        description: |
31
          Internal server error. Possible `error_code` attribute values:
31
          Internal server error. Possible `error_code` attribute values:
32
32
33
          * `internal_server_error`
33
          * `internal_server_error`
34
        schema:
34
        schema:
35
          $ref: ../definitions.yaml#/error
35
          $ref: "../swagger.yaml#/definitions/error"
36
      "503":
36
      "503":
37
        description: Under maintenance
37
        description: Under maintenance
38
        schema:
38
        schema:
39
          $ref: ../definitions.yaml#/error
39
          $ref: "../swagger.yaml#/definitions/error"
40
    x-koha-authorization:
40
    x-koha-authorization:
41
      permissions:
41
      permissions:
42
        ill: "1"
42
        ill: "1"
Lines 59-88 Link Here
59
      "200":
59
      "200":
60
        description: An ILL backends
60
        description: An ILL backends
61
        schema:
61
        schema:
62
          $ref: ../definitions.yaml#/ill_backend
62
          $ref: "../swagger.yaml#/definitions/ill_backend"
63
      "401":
63
      "401":
64
        description: Authentication required
64
        description: Authentication required
65
        schema:
65
        schema:
66
          $ref: ../definitions.yaml#/error
66
          $ref: "../swagger.yaml#/definitions/error"
67
      "403":
67
      "403":
68
        description: Access forbidden
68
        description: Access forbidden
69
        schema:
69
        schema:
70
          $ref: ../definitions.yaml#/error
70
          $ref: "../swagger.yaml#/definitions/error"
71
      "404":
71
      "404":
72
        description: ILL backends not found
72
        description: ILL backends not found
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/error
74
          $ref: "../swagger.yaml#/definitions/error"
75
      "500":
75
      "500":
76
        description: |
76
        description: |
77
          Internal server error. Possible `error_code` attribute values:
77
          Internal server error. Possible `error_code` attribute values:
78
78
79
          * `internal_server_error`
79
          * `internal_server_error`
80
        schema:
80
        schema:
81
          $ref: ../definitions.yaml#/error
81
          $ref: "../swagger.yaml#/definitions/error"
82
      "503":
82
      "503":
83
        description: Under maintenance
83
        description: Under maintenance
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
    x-koha-authorization:
86
    x-koha-authorization:
87
      permissions:
87
      permissions:
88
        ill: "1"
88
        ill: "1"
(-)a/api/v1/swagger/paths/illrequests.yaml (-5 / +5 lines)
Lines 106-131 Link Here
106
      "401":
106
      "401":
107
        description: Authentication required
107
        description: Authentication required
108
        schema:
108
        schema:
109
          $ref: ../definitions.yaml#/error
109
          $ref: "../swagger.yaml#/definitions/error"
110
      "403":
110
      "403":
111
        description: Access forbidden
111
        description: Access forbidden
112
        schema:
112
        schema:
113
          $ref: ../definitions.yaml#/error
113
          $ref: "../swagger.yaml#/definitions/error"
114
      "404":
114
      "404":
115
        description: ILL requests not found
115
        description: ILL requests not found
116
        schema:
116
        schema:
117
          $ref: ../definitions.yaml#/error
117
          $ref: "../swagger.yaml#/definitions/error"
118
      "500":
118
      "500":
119
        description: |
119
        description: |
120
          Internal server error. Possible `error_code` attribute values:
120
          Internal server error. Possible `error_code` attribute values:
121
121
122
          * `internal_server_error`
122
          * `internal_server_error`
123
        schema:
123
        schema:
124
          $ref: ../definitions.yaml#/error
124
          $ref: "../swagger.yaml#/definitions/error"
125
      "503":
125
      "503":
126
        description: Under maintenance
126
        description: Under maintenance
127
        schema:
127
        schema:
128
          $ref: ../definitions.yaml#/error
128
          $ref: "../swagger.yaml#/definitions/error"
129
    x-koha-authorization:
129
    x-koha-authorization:
130
      permissions:
130
      permissions:
131
        ill: "1"
131
        ill: "1"
(-)a/api/v1/swagger/paths/import_batch_profiles.yaml (-33 / +33 lines)
Lines 12-24 Link Here
12
        description: Search on profile's name
12
        description: Search on profile's name
13
        required: false
13
        required: false
14
        type: string
14
        type: string
15
      - $ref: ../parameters.yaml#/match
15
      - $ref: "../swagger.yaml#/parameters/match"
16
      - $ref: ../parameters.yaml#/order_by
16
      - $ref: "../swagger.yaml#/parameters/order_by"
17
      - $ref: ../parameters.yaml#/page
17
      - $ref: "../swagger.yaml#/parameters/page"
18
      - $ref: ../parameters.yaml#/per_page
18
      - $ref: "../swagger.yaml#/parameters/per_page"
19
      - $ref: ../parameters.yaml#/q_param
19
      - $ref: "../swagger.yaml#/parameters/q_param"
20
      - $ref: ../parameters.yaml#/q_body
20
      - $ref: "../swagger.yaml#/parameters/q_body"
21
      - $ref: ../parameters.yaml#/q_header
21
      - $ref: "../swagger.yaml#/parameters/q_header"
22
    consumes:
22
    consumes:
23
      - application/json
23
      - application/json
24
    produces:
24
    produces:
Lines 27-52 Link Here
27
      "200":
27
      "200":
28
        description: A list of import batch profiles
28
        description: A list of import batch profiles
29
        schema:
29
        schema:
30
          $ref: ../definitions.yaml#/import_batch_profiles
30
          $ref: "../swagger.yaml#/definitions/import_batch_profiles"
31
      "401":
31
      "401":
32
        description: Authentication required
32
        description: Authentication required
33
        schema:
33
        schema:
34
          $ref: ../definitions.yaml#/error
34
          $ref: "../swagger.yaml#/definitions/error"
35
      "403":
35
      "403":
36
        description: Access forbidden
36
        description: Access forbidden
37
        schema:
37
        schema:
38
          $ref: ../definitions.yaml#/error
38
          $ref: "../swagger.yaml#/definitions/error"
39
      "500":
39
      "500":
40
        description: |
40
        description: |
41
          Internal server error. Possible `error_code` attribute values:
41
          Internal server error. Possible `error_code` attribute values:
42
42
43
          * `internal_server_error`
43
          * `internal_server_error`
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "503":
46
      "503":
47
        description: Under maintenance
47
        description: Under maintenance
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
    x-koha-authorization:
50
    x-koha-authorization:
51
      permissions:
51
      permissions:
52
        tools: stage_marc_import
52
        tools: stage_marc_import
Lines 126-159 Link Here
126
      "201":
126
      "201":
127
        description: Created Profile
127
        description: Created Profile
128
        schema:
128
        schema:
129
          $ref: ../definitions.yaml#/import_batch_profile
129
          $ref: "../swagger.yaml#/definitions/import_batch_profile"
130
      "400":
130
      "400":
131
        description: Missing or wrong parameters
131
        description: Missing or wrong parameters
132
        schema:
132
        schema:
133
          $ref: ../definitions.yaml#/error
133
          $ref: "../swagger.yaml#/definitions/error"
134
      "401":
134
      "401":
135
        description: Authentication required
135
        description: Authentication required
136
        schema:
136
        schema:
137
          $ref: ../definitions.yaml#/error
137
          $ref: "../swagger.yaml#/definitions/error"
138
      "403":
138
      "403":
139
        description: Hold not allowed
139
        description: Hold not allowed
140
        schema:
140
        schema:
141
          $ref: ../definitions.yaml#/error
141
          $ref: "../swagger.yaml#/definitions/error"
142
      "404":
142
      "404":
143
        description: Borrower not found
143
        description: Borrower not found
144
        schema:
144
        schema:
145
          $ref: ../definitions.yaml#/error
145
          $ref: "../swagger.yaml#/definitions/error"
146
      "500":
146
      "500":
147
        description: |
147
        description: |
148
          Internal server error. Possible `error_code` attribute values:
148
          Internal server error. Possible `error_code` attribute values:
149
149
150
          * `internal_server_error`
150
          * `internal_server_error`
151
        schema:
151
        schema:
152
          $ref: ../definitions.yaml#/error
152
          $ref: "../swagger.yaml#/definitions/error"
153
      "503":
153
      "503":
154
        description: Under maintenance
154
        description: Under maintenance
155
        schema:
155
        schema:
156
          $ref: ../definitions.yaml#/error
156
          $ref: "../swagger.yaml#/definitions/error"
157
    x-koha-authorization:
157
    x-koha-authorization:
158
      permissions:
158
      permissions:
159
        tools: stage_marc_import
159
        tools: stage_marc_import
Lines 165-171 Link Here
165
      - batch_import_profiles
165
      - batch_import_profiles
166
    summary: Update batch import profile
166
    summary: Update batch import profile
167
    parameters:
167
    parameters:
168
      - $ref: ../parameters.yaml#/import_batch_profile_id_pp
168
      - $ref: "../swagger.yaml#/parameters/import_batch_profile_id_pp"
169
      - name: body
169
      - name: body
170
        in: body
170
        in: body
171
        description: A JSON object containing a import batch profile
171
        description: A JSON object containing a import batch profile
Lines 235-268 Link Here
235
      "200":
235
      "200":
236
        description: Updated profile
236
        description: Updated profile
237
        schema:
237
        schema:
238
          $ref: ../definitions.yaml#/import_batch_profile
238
          $ref: "../swagger.yaml#/definitions/import_batch_profile"
239
      "400":
239
      "400":
240
        description: Missing or wrong parameters
240
        description: Missing or wrong parameters
241
        schema:
241
        schema:
242
          $ref: ../definitions.yaml#/error
242
          $ref: "../swagger.yaml#/definitions/error"
243
      "401":
243
      "401":
244
        description: Authentication required
244
        description: Authentication required
245
        schema:
245
        schema:
246
          $ref: ../definitions.yaml#/error
246
          $ref: "../swagger.yaml#/definitions/error"
247
      "403":
247
      "403":
248
        description: Hold not allowed
248
        description: Hold not allowed
249
        schema:
249
        schema:
250
          $ref: ../definitions.yaml#/error
250
          $ref: "../swagger.yaml#/definitions/error"
251
      "404":
251
      "404":
252
        description: Borrower not found
252
        description: Borrower not found
253
        schema:
253
        schema:
254
          $ref: ../definitions.yaml#/error
254
          $ref: "../swagger.yaml#/definitions/error"
255
      "500":
255
      "500":
256
        description: |
256
        description: |
257
          Internal server error. Possible `error_code` attribute values:
257
          Internal server error. Possible `error_code` attribute values:
258
258
259
          * `internal_server_error`
259
          * `internal_server_error`
260
        schema:
260
        schema:
261
          $ref: ../definitions.yaml#/error
261
          $ref: "../swagger.yaml#/definitions/error"
262
      "503":
262
      "503":
263
        description: Under maintenance
263
        description: Under maintenance
264
        schema:
264
        schema:
265
          $ref: ../definitions.yaml#/error
265
          $ref: "../swagger.yaml#/definitions/error"
266
    x-koha-authorization:
266
    x-koha-authorization:
267
      permissions:
267
      permissions:
268
        tools: stage_marc_import
268
        tools: stage_marc_import
Lines 273-279 Link Here
273
      - batch_import_profiles
273
      - batch_import_profiles
274
    summary: Delete batch import profile
274
    summary: Delete batch import profile
275
    parameters:
275
    parameters:
276
      - $ref: ../parameters.yaml#/import_batch_profile_id_pp
276
      - $ref: "../swagger.yaml#/parameters/import_batch_profile_id_pp"
277
    produces:
277
    produces:
278
      - application/json
278
      - application/json
279
    responses:
279
    responses:
Lines 282-307 Link Here
282
      "401":
282
      "401":
283
        description: Authentication required
283
        description: Authentication required
284
        schema:
284
        schema:
285
          $ref: ../definitions.yaml#/error
285
          $ref: "../swagger.yaml#/definitions/error"
286
      "403":
286
      "403":
287
        description: Hold not allowed
287
        description: Hold not allowed
288
        schema:
288
        schema:
289
          $ref: ../definitions.yaml#/error
289
          $ref: "../swagger.yaml#/definitions/error"
290
      "404":
290
      "404":
291
        description: Hold not found
291
        description: Hold not found
292
        schema:
292
        schema:
293
          $ref: ../definitions.yaml#/error
293
          $ref: "../swagger.yaml#/definitions/error"
294
      "500":
294
      "500":
295
        description: |
295
        description: |
296
          Internal server error. Possible `error_code` attribute values:
296
          Internal server error. Possible `error_code` attribute values:
297
297
298
          * `internal_server_error`
298
          * `internal_server_error`
299
        schema:
299
        schema:
300
          $ref: ../definitions.yaml#/error
300
          $ref: "../swagger.yaml#/definitions/error"
301
      "503":
301
      "503":
302
        description: Under maintenance
302
        description: Under maintenance
303
        schema:
303
        schema:
304
          $ref: ../definitions.yaml#/error
304
          $ref: "../swagger.yaml#/definitions/error"
305
    x-koha-authorization:
305
    x-koha-authorization:
306
      permissions:
306
      permissions:
307
        tools: stage_marc_import
307
        tools: stage_marc_import
(-)a/api/v1/swagger/paths/items.yaml (-33 / +33 lines)
Lines 12-24 Link Here
12
        description: Search on the item's barcode
12
        description: Search on the item's barcode
13
        required: false
13
        required: false
14
        type: string
14
        type: string
15
      - $ref: ../parameters.yaml#/match
15
      - $ref: "../swagger.yaml#/parameters/match"
16
      - $ref: ../parameters.yaml#/order_by
16
      - $ref: "../swagger.yaml#/parameters/order_by"
17
      - $ref: ../parameters.yaml#/page
17
      - $ref: "../swagger.yaml#/parameters/page"
18
      - $ref: ../parameters.yaml#/per_page
18
      - $ref: "../swagger.yaml#/parameters/per_page"
19
      - $ref: ../parameters.yaml#/q_param
19
      - $ref: "../swagger.yaml#/parameters/q_param"
20
      - $ref: ../parameters.yaml#/q_body
20
      - $ref: "../swagger.yaml#/parameters/q_body"
21
      - $ref: ../parameters.yaml#/q_header
21
      - $ref: "../swagger.yaml#/parameters/q_header"
22
    consumes:
22
    consumes:
23
      - application/json
23
      - application/json
24
    produces:
24
    produces:
Lines 29-54 Link Here
29
        schema:
29
        schema:
30
          type: array
30
          type: array
31
          items:
31
          items:
32
            $ref: ../definitions.yaml#/item
32
            $ref: "../swagger.yaml#/definitions/item"
33
      "401":
33
      "401":
34
        description: Authentication required
34
        description: Authentication required
35
        schema:
35
        schema:
36
          $ref: ../definitions.yaml#/error
36
          $ref: "../swagger.yaml#/definitions/error"
37
      "403":
37
      "403":
38
        description: Access forbidden
38
        description: Access forbidden
39
        schema:
39
        schema:
40
          $ref: ../definitions.yaml#/error
40
          $ref: "../swagger.yaml#/definitions/error"
41
      "500":
41
      "500":
42
        description: |
42
        description: |
43
          Internal server error. Possible `error_code` attribute values:
43
          Internal server error. Possible `error_code` attribute values:
44
44
45
          * `internal_server_error`
45
          * `internal_server_error`
46
        schema:
46
        schema:
47
          $ref: ../definitions.yaml#/error
47
          $ref: "../swagger.yaml#/definitions/error"
48
      "503":
48
      "503":
49
        description: Under maintenance
49
        description: Under maintenance
50
        schema:
50
        schema:
51
          $ref: ../definitions.yaml#/error
51
          $ref: "../swagger.yaml#/definitions/error"
52
    x-koha-authorization:
52
    x-koha-authorization:
53
      permissions:
53
      permissions:
54
        catalogue: "1"
54
        catalogue: "1"
Lines 60-66 Link Here
60
      - items
60
      - items
61
    summary: Get item
61
    summary: Get item
62
    parameters:
62
    parameters:
63
      - $ref: ../parameters.yaml#/item_id_pp
63
      - $ref: "../swagger.yaml#/parameters/item_id_pp"
64
    consumes:
64
    consumes:
65
      - application/json
65
      - application/json
66
    produces:
66
    produces:
Lines 69-94 Link Here
69
      "200":
69
      "200":
70
        description: An item
70
        description: An item
71
        schema:
71
        schema:
72
          $ref: ../definitions.yaml#/item
72
          $ref: "../swagger.yaml#/definitions/item"
73
      "400":
73
      "400":
74
        description: Missing or wrong parameters
74
        description: Missing or wrong parameters
75
        schema:
75
        schema:
76
          $ref: ../definitions.yaml#/error
76
          $ref: "../swagger.yaml#/definitions/error"
77
      "404":
77
      "404":
78
        description: Item not found
78
        description: Item not found
79
        schema:
79
        schema:
80
          $ref: ../definitions.yaml#/error
80
          $ref: "../swagger.yaml#/definitions/error"
81
      "500":
81
      "500":
82
        description: |
82
        description: |
83
          Internal server error. Possible `error_code` attribute values:
83
          Internal server error. Possible `error_code` attribute values:
84
84
85
          * `internal_server_error`
85
          * `internal_server_error`
86
        schema:
86
        schema:
87
          $ref: ../definitions.yaml#/error
87
          $ref: "../swagger.yaml#/definitions/error"
88
      "503":
88
      "503":
89
        description: Under maintenance
89
        description: Under maintenance
90
        schema:
90
        schema:
91
          $ref: ../definitions.yaml#/error
91
          $ref: "../swagger.yaml#/definitions/error"
92
    x-koha-authorization:
92
    x-koha-authorization:
93
      permissions:
93
      permissions:
94
        catalogue: "1"
94
        catalogue: "1"
Lines 100-118 Link Here
100
    tags:
100
    tags:
101
      - items
101
      - items
102
    parameters:
102
    parameters:
103
      - $ref: ../parameters.yaml#/item_id_pp
103
      - $ref: "../swagger.yaml#/parameters/item_id_pp"
104
      - name: patron_id
104
      - name: patron_id
105
        in: query
105
        in: query
106
        description: Internal patron identifier
106
        description: Internal patron identifier
107
        required: true
107
        required: true
108
        type: integer
108
        type: integer
109
      - $ref: ../parameters.yaml#/match
109
      - $ref: "../swagger.yaml#/parameters/match"
110
      - $ref: ../parameters.yaml#/order_by
110
      - $ref: "../swagger.yaml#/parameters/order_by"
111
      - $ref: ../parameters.yaml#/page
111
      - $ref: "../swagger.yaml#/parameters/page"
112
      - $ref: ../parameters.yaml#/per_page
112
      - $ref: "../swagger.yaml#/parameters/per_page"
113
      - $ref: ../parameters.yaml#/q_param
113
      - $ref: "../swagger.yaml#/parameters/q_param"
114
      - $ref: ../parameters.yaml#/q_body
114
      - $ref: "../swagger.yaml#/parameters/q_body"
115
      - $ref: ../parameters.yaml#/q_header
115
      - $ref: "../swagger.yaml#/parameters/q_header"
116
    consumes:
116
    consumes:
117
      - application/json
117
      - application/json
118
    produces:
118
    produces:
Lines 123-156 Link Here
123
        schema:
123
        schema:
124
          type: array
124
          type: array
125
          items:
125
          items:
126
            $ref: ../definitions.yaml#/library
126
            $ref: "../swagger.yaml#/definitions/library"
127
      "400":
127
      "400":
128
        description: Missing or wrong parameters
128
        description: Missing or wrong parameters
129
        schema:
129
        schema:
130
          $ref: ../definitions.yaml#/error
130
          $ref: "../swagger.yaml#/definitions/error"
131
      "401":
131
      "401":
132
        description: Authentication required
132
        description: Authentication required
133
        schema:
133
        schema:
134
          $ref: ../definitions.yaml#/error
134
          $ref: "../swagger.yaml#/definitions/error"
135
      "403":
135
      "403":
136
        description: Access forbidden
136
        description: Access forbidden
137
        schema:
137
        schema:
138
          $ref: ../definitions.yaml#/error
138
          $ref: "../swagger.yaml#/definitions/error"
139
      "404":
139
      "404":
140
        description: Biblio not found
140
        description: Biblio not found
141
        schema:
141
        schema:
142
          $ref: ../definitions.yaml#/error
142
          $ref: "../swagger.yaml#/definitions/error"
143
      "500":
143
      "500":
144
        description: |
144
        description: |
145
          Internal server error. Possible `error_code` attribute values:
145
          Internal server error. Possible `error_code` attribute values:
146
146
147
          * `internal_server_error`
147
          * `internal_server_error`
148
        schema:
148
        schema:
149
          $ref: ../definitions.yaml#/error
149
          $ref: "../swagger.yaml#/definitions/error"
150
      "503":
150
      "503":
151
        description: Under maintenance
151
        description: Under maintenance
152
        schema:
152
        schema:
153
          $ref: ../definitions.yaml#/error
153
          $ref: "../swagger.yaml#/definitions/error"
154
    x-koha-authorization:
154
    x-koha-authorization:
155
      permissions:
155
      permissions:
156
        reserveforothers: place_holds
156
        reserveforothers: place_holds
(-)a/api/v1/swagger/paths/libraries.yaml (-52 / +52 lines)
Lines 92-104 Link Here
92
        description: Case insensitive 'starts-with' search on OPAC info
92
        description: Case insensitive 'starts-with' search on OPAC info
93
        required: false
93
        required: false
94
        type: string
94
        type: string
95
      - $ref: ../parameters.yaml#/match
95
      - $ref: "../swagger.yaml#/parameters/match"
96
      - $ref: ../parameters.yaml#/order_by
96
      - $ref: "../swagger.yaml#/parameters/order_by"
97
      - $ref: ../parameters.yaml#/page
97
      - $ref: "../swagger.yaml#/parameters/page"
98
      - $ref: ../parameters.yaml#/per_page
98
      - $ref: "../swagger.yaml#/parameters/per_page"
99
      - $ref: ../parameters.yaml#/q_param
99
      - $ref: "../swagger.yaml#/parameters/q_param"
100
      - $ref: ../parameters.yaml#/q_body
100
      - $ref: "../swagger.yaml#/parameters/q_body"
101
      - $ref: ../parameters.yaml#/q_header
101
      - $ref: "../swagger.yaml#/parameters/q_header"
102
    produces:
102
    produces:
103
      - application/json
103
      - application/json
104
    responses:
104
    responses:
Lines 107-124 Link Here
107
        schema:
107
        schema:
108
          type: array
108
          type: array
109
          items:
109
          items:
110
            $ref: ../definitions.yaml#/library
110
            $ref: "../swagger.yaml#/definitions/library"
111
      "500":
111
      "500":
112
        description: |
112
        description: |
113
          Internal server error. Possible `error_code` attribute values:
113
          Internal server error. Possible `error_code` attribute values:
114
114
115
          * `internal_server_error`
115
          * `internal_server_error`
116
        schema:
116
        schema:
117
          $ref: ../definitions.yaml#/error
117
          $ref: "../swagger.yaml#/definitions/error"
118
      "503":
118
      "503":
119
        description: Under maintenance
119
        description: Under maintenance
120
        schema:
120
        schema:
121
          $ref: ../definitions.yaml#/error
121
          $ref: "../swagger.yaml#/definitions/error"
122
    x-koha-authorization:
122
    x-koha-authorization:
123
      permissions:
123
      permissions:
124
        catalogue: "1"
124
        catalogue: "1"
Lines 136-176 Link Here
136
        description: A JSON object containing informations about the new library
136
        description: A JSON object containing informations about the new library
137
        required: true
137
        required: true
138
        schema:
138
        schema:
139
          $ref: ../definitions.yaml#/library
139
          $ref: "../swagger.yaml#/definitions/library"
140
    produces:
140
    produces:
141
      - application/json
141
      - application/json
142
    responses:
142
    responses:
143
      "201":
143
      "201":
144
        description: Library added
144
        description: Library added
145
        schema:
145
        schema:
146
          $ref: ../definitions.yaml#/library
146
          $ref: "../swagger.yaml#/definitions/library"
147
      "400":
147
      "400":
148
        description: Bad request
148
        description: Bad request
149
        schema:
149
        schema:
150
          $ref: ../definitions.yaml#/error
150
          $ref: "../swagger.yaml#/definitions/error"
151
      "401":
151
      "401":
152
        description: Authentication required
152
        description: Authentication required
153
        schema:
153
        schema:
154
          $ref: ../definitions.yaml#/error
154
          $ref: "../swagger.yaml#/definitions/error"
155
      "403":
155
      "403":
156
        description: Access forbidden
156
        description: Access forbidden
157
        schema:
157
        schema:
158
          $ref: ../definitions.yaml#/error
158
          $ref: "../swagger.yaml#/definitions/error"
159
      "409":
159
      "409":
160
        description: Conflict in creating resource
160
        description: Conflict in creating resource
161
        schema:
161
        schema:
162
          $ref: ../definitions.yaml#/error
162
          $ref: "../swagger.yaml#/definitions/error"
163
      "500":
163
      "500":
164
        description: |
164
        description: |
165
          Internal server error. Possible `error_code` attribute values:
165
          Internal server error. Possible `error_code` attribute values:
166
166
167
          * `internal_server_error`
167
          * `internal_server_error`
168
        schema:
168
        schema:
169
          $ref: ../definitions.yaml#/error
169
          $ref: "../swagger.yaml#/definitions/error"
170
      "503":
170
      "503":
171
        description: Under maintenance
171
        description: Under maintenance
172
        schema:
172
        schema:
173
          $ref: ../definitions.yaml#/error
173
          $ref: "../swagger.yaml#/definitions/error"
174
    x-koha-authorization:
174
    x-koha-authorization:
175
      permissions:
175
      permissions:
176
        parameters: manage_libraries
176
        parameters: manage_libraries
Lines 182-199 Link Here
182
      - libraries
182
      - libraries
183
    summary: Get library
183
    summary: Get library
184
    parameters:
184
    parameters:
185
      - $ref: ../parameters.yaml#/library_id_pp
185
      - $ref: "../swagger.yaml#/parameters/library_id_pp"
186
    produces:
186
    produces:
187
      - application/json
187
      - application/json
188
    responses:
188
    responses:
189
      "200":
189
      "200":
190
        description: A library
190
        description: A library
191
        schema:
191
        schema:
192
          $ref: ../definitions.yaml#/library
192
          $ref: "../swagger.yaml#/definitions/library"
193
      "404":
193
      "404":
194
        description: Library not found
194
        description: Library not found
195
        schema:
195
        schema:
196
          $ref: ../definitions.yaml#/error
196
          $ref: "../swagger.yaml#/definitions/error"
197
    x-koha-authorization:
197
    x-koha-authorization:
198
      permissions:
198
      permissions:
199
        catalogue: "1"
199
        catalogue: "1"
Lines 206-218 Link Here
206
      - libraries
206
      - libraries
207
    summary: Update library
207
    summary: Update library
208
    parameters:
208
    parameters:
209
      - $ref: ../parameters.yaml#/library_id_pp
209
      - $ref: "../swagger.yaml#/parameters/library_id_pp"
210
      - name: body
210
      - name: body
211
        in: body
211
        in: body
212
        description: A JSON object containing information on the library
212
        description: A JSON object containing information on the library
213
        required: true
213
        required: true
214
        schema:
214
        schema:
215
          $ref: ../definitions.yaml#/library
215
          $ref: "../swagger.yaml#/definitions/library"
216
    consumes:
216
    consumes:
217
      - application/json
217
      - application/json
218
    produces:
218
    produces:
Lines 221-254 Link Here
221
      "200":
221
      "200":
222
        description: A library
222
        description: A library
223
        schema:
223
        schema:
224
          $ref: ../definitions.yaml#/library
224
          $ref: "../swagger.yaml#/definitions/library"
225
      "400":
225
      "400":
226
        description: Bad request
226
        description: Bad request
227
        schema:
227
        schema:
228
          $ref: ../definitions.yaml#/error
228
          $ref: "../swagger.yaml#/definitions/error"
229
      "401":
229
      "401":
230
        description: Authentication required
230
        description: Authentication required
231
        schema:
231
        schema:
232
          $ref: ../definitions.yaml#/error
232
          $ref: "../swagger.yaml#/definitions/error"
233
      "403":
233
      "403":
234
        description: Access forbidden
234
        description: Access forbidden
235
        schema:
235
        schema:
236
          $ref: ../definitions.yaml#/error
236
          $ref: "../swagger.yaml#/definitions/error"
237
      "404":
237
      "404":
238
        description: Library not found
238
        description: Library not found
239
        schema:
239
        schema:
240
          $ref: ../definitions.yaml#/error
240
          $ref: "../swagger.yaml#/definitions/error"
241
      "500":
241
      "500":
242
        description: |
242
        description: |
243
          Internal server error. Possible `error_code` attribute values:
243
          Internal server error. Possible `error_code` attribute values:
244
244
245
          * `internal_server_error`
245
          * `internal_server_error`
246
        schema:
246
        schema:
247
          $ref: ../definitions.yaml#/error
247
          $ref: "../swagger.yaml#/definitions/error"
248
      "503":
248
      "503":
249
        description: Under maintenance
249
        description: Under maintenance
250
        schema:
250
        schema:
251
          $ref: ../definitions.yaml#/error
251
          $ref: "../swagger.yaml#/definitions/error"
252
    x-koha-authorization:
252
    x-koha-authorization:
253
      permissions:
253
      permissions:
254
        parameters: manage_libraries
254
        parameters: manage_libraries
Lines 259-265 Link Here
259
      - libraries
259
      - libraries
260
    summary: Delete library
260
    summary: Delete library
261
    parameters:
261
    parameters:
262
      - $ref: ../parameters.yaml#/library_id_pp
262
      - $ref: "../swagger.yaml#/parameters/library_id_pp"
263
    produces:
263
    produces:
264
      - application/json
264
      - application/json
265
    responses:
265
    responses:
Lines 270-295 Link Here
270
      "401":
270
      "401":
271
        description: Authentication required
271
        description: Authentication required
272
        schema:
272
        schema:
273
          $ref: ../definitions.yaml#/error
273
          $ref: "../swagger.yaml#/definitions/error"
274
      "403":
274
      "403":
275
        description: Access forbidden
275
        description: Access forbidden
276
        schema:
276
        schema:
277
          $ref: ../definitions.yaml#/error
277
          $ref: "../swagger.yaml#/definitions/error"
278
      "404":
278
      "404":
279
        description: Library not found
279
        description: Library not found
280
        schema:
280
        schema:
281
          $ref: ../definitions.yaml#/error
281
          $ref: "../swagger.yaml#/definitions/error"
282
      "500":
282
      "500":
283
        description: |
283
        description: |
284
          Internal server error. Possible `error_code` attribute values:
284
          Internal server error. Possible `error_code` attribute values:
285
285
286
          * `internal_server_error`
286
          * `internal_server_error`
287
        schema:
287
        schema:
288
          $ref: ../definitions.yaml#/error
288
          $ref: "../swagger.yaml#/definitions/error"
289
      "503":
289
      "503":
290
        description: Under maintenance
290
        description: Under maintenance
291
        schema:
291
        schema:
292
          $ref: ../definitions.yaml#/error
292
          $ref: "../swagger.yaml#/definitions/error"
293
    x-koha-authorization:
293
    x-koha-authorization:
294
      permissions:
294
      permissions:
295
        parameters: manage_libraries
295
        parameters: manage_libraries
Lines 301-313 Link Here
301
      - libraries
301
      - libraries
302
    summary: List libraries
302
    summary: List libraries
303
    parameters:
303
    parameters:
304
      - $ref: ../parameters.yaml#/match
304
      - $ref: "../swagger.yaml#/parameters/match"
305
      - $ref: ../parameters.yaml#/order_by
305
      - $ref: "../swagger.yaml#/parameters/order_by"
306
      - $ref: ../parameters.yaml#/page
306
      - $ref: "../swagger.yaml#/parameters/page"
307
      - $ref: ../parameters.yaml#/per_page
307
      - $ref: "../swagger.yaml#/parameters/per_page"
308
      - $ref: ../parameters.yaml#/q_param
308
      - $ref: "../swagger.yaml#/parameters/q_param"
309
      - $ref: ../parameters.yaml#/q_body
309
      - $ref: "../swagger.yaml#/parameters/q_body"
310
      - $ref: ../parameters.yaml#/q_header
310
      - $ref: "../swagger.yaml#/parameters/q_header"
311
    produces:
311
    produces:
312
      - application/json
312
      - application/json
313
    responses:
313
    responses:
Lines 316-333 Link Here
316
        schema:
316
        schema:
317
          type: array
317
          type: array
318
          items:
318
          items:
319
            $ref: ../definitions.yaml#/library
319
            $ref: "../swagger.yaml#/definitions/library"
320
      "500":
320
      "500":
321
        description: |
321
        description: |
322
          Internal server error. Possible `error_code` attribute values:
322
          Internal server error. Possible `error_code` attribute values:
323
323
324
          * `internal_server_error`
324
          * `internal_server_error`
325
        schema:
325
        schema:
326
          $ref: ../definitions.yaml#/error
326
          $ref: "../swagger.yaml#/definitions/error"
327
      "503":
327
      "503":
328
        description: Under maintenance
328
        description: Under maintenance
329
        schema:
329
        schema:
330
          $ref: ../definitions.yaml#/error
330
          $ref: "../swagger.yaml#/definitions/error"
331
"/public/libraries/{library_id}":
331
"/public/libraries/{library_id}":
332
  get:
332
  get:
333
    x-mojo-to: Libraries#get
333
    x-mojo-to: Libraries#get
Lines 336-342 Link Here
336
      - libraries
336
      - libraries
337
    summary: Get library (public)
337
    summary: Get library (public)
338
    parameters:
338
    parameters:
339
      - $ref: ../parameters.yaml#/library_id_pp
339
      - $ref: "../swagger.yaml#/parameters/library_id_pp"
340
    produces:
340
    produces:
341
      - application/json
341
      - application/json
342
    responses:
342
    responses:
Lines 345-359 Link Here
345
      "401":
345
      "401":
346
        description: Authentication required
346
        description: Authentication required
347
        schema:
347
        schema:
348
          $ref: ../definitions.yaml#/error
348
          $ref: "../swagger.yaml#/definitions/error"
349
      "403":
349
      "403":
350
        description: Access forbidden
350
        description: Access forbidden
351
        schema:
351
        schema:
352
          $ref: ../definitions.yaml#/error
352
          $ref: "../swagger.yaml#/definitions/error"
353
      "404":
353
      "404":
354
        description: Library not found
354
        description: Library not found
355
        schema:
355
        schema:
356
          $ref: ../definitions.yaml#/error
356
          $ref: "../swagger.yaml#/definitions/error"
357
      "406":
357
      "406":
358
        description: Not acceptable
358
        description: Not acceptable
359
        schema:
359
        schema:
Lines 367-374 Link Here
367
367
368
          * `internal_server_error`
368
          * `internal_server_error`
369
        schema:
369
        schema:
370
          $ref: ../definitions.yaml#/error
370
          $ref: "../swagger.yaml#/definitions/error"
371
      "503":
371
      "503":
372
        description: Under maintenance
372
        description: Under maintenance
373
        schema:
373
        schema:
374
          $ref: ../definitions.yaml#/error
374
          $ref: "../swagger.yaml#/definitions/error"
(-)a/api/v1/swagger/paths/oauth.yaml (-2 / +2 lines)
Lines 38-45 Link Here
38
      "400":
38
      "400":
39
        description: Bad Request
39
        description: Bad Request
40
        schema:
40
        schema:
41
          $ref: ../definitions.yaml#/error
41
          $ref: "../swagger.yaml#/definitions/error"
42
      "403":
42
      "403":
43
        description: Access forbidden
43
        description: Access forbidden
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
(-)a/api/v1/swagger/paths/patrons.yaml (-45 / +45 lines)
Lines 344-382 Link Here
344
        description: Search on login_attempts
344
        description: Search on login_attempts
345
        required: false
345
        required: false
346
        type: string
346
        type: string
347
      - $ref: ../parameters.yaml#/match
347
      - $ref: "../swagger.yaml#/parameters/match"
348
      - $ref: ../parameters.yaml#/order_by
348
      - $ref: "../swagger.yaml#/parameters/order_by"
349
      - $ref: ../parameters.yaml#/page
349
      - $ref: "../swagger.yaml#/parameters/page"
350
      - $ref: ../parameters.yaml#/per_page
350
      - $ref: "../swagger.yaml#/parameters/per_page"
351
      - $ref: ../parameters.yaml#/q_param
351
      - $ref: "../swagger.yaml#/parameters/q_param"
352
      - $ref: ../parameters.yaml#/q_body
352
      - $ref: "../swagger.yaml#/parameters/q_body"
353
      - $ref: ../parameters.yaml#/q_header
353
      - $ref: "../swagger.yaml#/parameters/q_header"
354
    responses:
354
    responses:
355
      "200":
355
      "200":
356
        description: A list of patrons
356
        description: A list of patrons
357
        schema:
357
        schema:
358
          type: array
358
          type: array
359
          items:
359
          items:
360
            $ref: ../definitions.yaml#/patron
360
            $ref: "../swagger.yaml#/definitions/patron"
361
      "401":
361
      "401":
362
        description: Authentication required
362
        description: Authentication required
363
        schema:
363
        schema:
364
          $ref: ../definitions.yaml#/error
364
          $ref: "../swagger.yaml#/definitions/error"
365
      "403":
365
      "403":
366
        description: Access forbidden
366
        description: Access forbidden
367
        schema:
367
        schema:
368
          $ref: ../definitions.yaml#/error
368
          $ref: "../swagger.yaml#/definitions/error"
369
      "500":
369
      "500":
370
        description: |
370
        description: |
371
          Internal server error. Possible `error_code` attribute values:
371
          Internal server error. Possible `error_code` attribute values:
372
372
373
          * `internal_server_error`
373
          * `internal_server_error`
374
        schema:
374
        schema:
375
          $ref: ../definitions.yaml#/error
375
          $ref: "../swagger.yaml#/definitions/error"
376
      "503":
376
      "503":
377
        description: Under maintenance
377
        description: Under maintenance
378
        schema:
378
        schema:
379
          $ref: ../definitions.yaml#/error
379
          $ref: "../swagger.yaml#/definitions/error"
380
    x-koha-authorization:
380
    x-koha-authorization:
381
      permissions:
381
      permissions:
382
        borrowers: "1"
382
        borrowers: "1"
Lines 394-400 Link Here
394
        description: A JSON object containing information about the new patron
394
        description: A JSON object containing information about the new patron
395
        required: true
395
        required: true
396
        schema:
396
        schema:
397
          $ref: ../definitions.yaml#/patron
397
          $ref: "../swagger.yaml#/definitions/patron"
398
    consumes:
398
    consumes:
399
      - application/json
399
      - application/json
400
    produces:
400
    produces:
Lines 404-441 Link Here
404
        description: A successfully created patron
404
        description: A successfully created patron
405
        schema:
405
        schema:
406
          items:
406
          items:
407
            $ref: ../definitions.yaml#/patron
407
            $ref: "../swagger.yaml#/definitions/patron"
408
      "400":
408
      "400":
409
        description: Bad parameter
409
        description: Bad parameter
410
        schema:
410
        schema:
411
          $ref: ../definitions.yaml#/error
411
          $ref: "../swagger.yaml#/definitions/error"
412
      "401":
412
      "401":
413
        description: Authentication required
413
        description: Authentication required
414
        schema:
414
        schema:
415
          $ref: ../definitions.yaml#/error
415
          $ref: "../swagger.yaml#/definitions/error"
416
      "403":
416
      "403":
417
        description: Access forbidden
417
        description: Access forbidden
418
        schema:
418
        schema:
419
          $ref: ../definitions.yaml#/error
419
          $ref: "../swagger.yaml#/definitions/error"
420
      "404":
420
      "404":
421
        description: Resource not found
421
        description: Resource not found
422
        schema:
422
        schema:
423
          $ref: ../definitions.yaml#/error
423
          $ref: "../swagger.yaml#/definitions/error"
424
      "409":
424
      "409":
425
        description: Conflict in creating resource
425
        description: Conflict in creating resource
426
        schema:
426
        schema:
427
          $ref: ../definitions.yaml#/error
427
          $ref: "../swagger.yaml#/definitions/error"
428
      "500":
428
      "500":
429
        description: |
429
        description: |
430
          Internal server error. Possible `error_code` attribute values:
430
          Internal server error. Possible `error_code` attribute values:
431
431
432
          * `internal_server_error`
432
          * `internal_server_error`
433
        schema:
433
        schema:
434
          $ref: ../definitions.yaml#/error
434
          $ref: "../swagger.yaml#/definitions/error"
435
      "503":
435
      "503":
436
        description: Under maintenance
436
        description: Under maintenance
437
        schema:
437
        schema:
438
          $ref: ../definitions.yaml#/error
438
          $ref: "../swagger.yaml#/definitions/error"
439
    x-koha-authorization:
439
    x-koha-authorization:
440
      permissions:
440
      permissions:
441
        borrowers: edit_borrowers
441
        borrowers: edit_borrowers
Lines 447-483 Link Here
447
      - patrons
447
      - patrons
448
    summary: Get patron
448
    summary: Get patron
449
    parameters:
449
    parameters:
450
      - $ref: ../parameters.yaml#/patron_id_pp
450
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
451
    produces:
451
    produces:
452
      - application/json
452
      - application/json
453
    responses:
453
    responses:
454
      "200":
454
      "200":
455
        description: A patron
455
        description: A patron
456
        schema:
456
        schema:
457
          $ref: ../definitions.yaml#/patron
457
          $ref: "../swagger.yaml#/definitions/patron"
458
      "401":
458
      "401":
459
        description: Authentication required
459
        description: Authentication required
460
        schema:
460
        schema:
461
          $ref: ../definitions.yaml#/error
461
          $ref: "../swagger.yaml#/definitions/error"
462
      "403":
462
      "403":
463
        description: Access forbidden
463
        description: Access forbidden
464
        schema:
464
        schema:
465
          $ref: ../definitions.yaml#/error
465
          $ref: "../swagger.yaml#/definitions/error"
466
      "404":
466
      "404":
467
        description: Patron not found
467
        description: Patron not found
468
        schema:
468
        schema:
469
          $ref: ../definitions.yaml#/error
469
          $ref: "../swagger.yaml#/definitions/error"
470
      "500":
470
      "500":
471
        description: |
471
        description: |
472
          Internal server error. Possible `error_code` attribute values:
472
          Internal server error. Possible `error_code` attribute values:
473
473
474
          * `internal_server_error`
474
          * `internal_server_error`
475
        schema:
475
        schema:
476
          $ref: ../definitions.yaml#/error
476
          $ref: "../swagger.yaml#/definitions/error"
477
      "503":
477
      "503":
478
        description: Under maintenance
478
        description: Under maintenance
479
        schema:
479
        schema:
480
          $ref: ../definitions.yaml#/error
480
          $ref: "../swagger.yaml#/definitions/error"
481
    x-koha-authorization:
481
    x-koha-authorization:
482
      permissions:
482
      permissions:
483
        borrowers: edit_borrowers
483
        borrowers: edit_borrowers
Lines 490-502 Link Here
490
      - patrons
490
      - patrons
491
    summary: Update patron
491
    summary: Update patron
492
    parameters:
492
    parameters:
493
      - $ref: ../parameters.yaml#/patron_id_pp
493
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
494
      - name: body
494
      - name: body
495
        in: body
495
        in: body
496
        description: A JSON object containing new information about existing patron
496
        description: A JSON object containing new information about existing patron
497
        required: true
497
        required: true
498
        schema:
498
        schema:
499
          $ref: ../definitions.yaml#/patron
499
          $ref: "../swagger.yaml#/definitions/patron"
500
    consumes:
500
    consumes:
501
      - application/json
501
      - application/json
502
    produces:
502
    produces:
Lines 506-539 Link Here
506
        description: A successfully updated patron
506
        description: A successfully updated patron
507
        schema:
507
        schema:
508
          items:
508
          items:
509
            $ref: ../definitions.yaml#/patron
509
            $ref: "../swagger.yaml#/definitions/patron"
510
      "400":
510
      "400":
511
        description: Bad parameter
511
        description: Bad parameter
512
        schema:
512
        schema:
513
          $ref: ../definitions.yaml#/error
513
          $ref: "../swagger.yaml#/definitions/error"
514
      "403":
514
      "403":
515
        description: Access forbidden
515
        description: Access forbidden
516
        schema:
516
        schema:
517
          $ref: ../definitions.yaml#/error
517
          $ref: "../swagger.yaml#/definitions/error"
518
      "404":
518
      "404":
519
        description: Resource not found
519
        description: Resource not found
520
        schema:
520
        schema:
521
          $ref: ../definitions.yaml#/error
521
          $ref: "../swagger.yaml#/definitions/error"
522
      "409":
522
      "409":
523
        description: Conflict in updating resource
523
        description: Conflict in updating resource
524
        schema:
524
        schema:
525
          $ref: ../definitions.yaml#/error
525
          $ref: "../swagger.yaml#/definitions/error"
526
      "500":
526
      "500":
527
        description: |
527
        description: |
528
          Internal server error. Possible `error_code` attribute values:
528
          Internal server error. Possible `error_code` attribute values:
529
529
530
          * `internal_server_error`
530
          * `internal_server_error`
531
        schema:
531
        schema:
532
          $ref: ../definitions.yaml#/error
532
          $ref: "../swagger.yaml#/definitions/error"
533
      "503":
533
      "503":
534
        description: Under maintenance
534
        description: Under maintenance
535
        schema:
535
        schema:
536
          $ref: ../definitions.yaml#/error
536
          $ref: "../swagger.yaml#/definitions/error"
537
    x-koha-authorization:
537
    x-koha-authorization:
538
      permissions:
538
      permissions:
539
        borrowers: "1"
539
        borrowers: "1"
Lines 544-550 Link Here
544
      - patrons
544
      - patrons
545
    summary: Delete patron
545
    summary: Delete patron
546
    parameters:
546
    parameters:
547
      - $ref: ../parameters.yaml#/patron_id_pp
547
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
548
    produces:
548
    produces:
549
      - application/json
549
      - application/json
550
    responses:
550
    responses:
Lines 553-571 Link Here
553
      "400":
553
      "400":
554
        description: Patron deletion failed
554
        description: Patron deletion failed
555
        schema:
555
        schema:
556
          $ref: ../definitions.yaml#/error
556
          $ref: "../swagger.yaml#/definitions/error"
557
      "401":
557
      "401":
558
        description: Authentication required
558
        description: Authentication required
559
        schema:
559
        schema:
560
          $ref: ../definitions.yaml#/error
560
          $ref: "../swagger.yaml#/definitions/error"
561
      "403":
561
      "403":
562
        description: Access forbidden
562
        description: Access forbidden
563
        schema:
563
        schema:
564
          $ref: ../definitions.yaml#/error
564
          $ref: "../swagger.yaml#/definitions/error"
565
      "404":
565
      "404":
566
        description: Patron not found
566
        description: Patron not found
567
        schema:
567
        schema:
568
          $ref: ../definitions.yaml#/error
568
          $ref: "../swagger.yaml#/definitions/error"
569
      "409":
569
      "409":
570
        description: |
570
        description: |
571
          Conflict. Possible `error_code` attribute values:
571
          Conflict. Possible `error_code` attribute values:
Lines 575-592 Link Here
575
            * `has_guarantees`: The patron has guarantees
575
            * `has_guarantees`: The patron has guarantees
576
            * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted
576
            * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted
577
        schema:
577
        schema:
578
          $ref: ../definitions.yaml#/error
578
          $ref: "../swagger.yaml#/definitions/error"
579
      "500":
579
      "500":
580
        description: |
580
        description: |
581
          Internal server error. Possible `error_code` attribute values:
581
          Internal server error. Possible `error_code` attribute values:
582
582
583
          * `internal_server_error`
583
          * `internal_server_error`
584
        schema:
584
        schema:
585
          $ref: ../definitions.yaml#/error
585
          $ref: "../swagger.yaml#/definitions/error"
586
      "503":
586
      "503":
587
        description: Under maintenance
587
        description: Under maintenance
588
        schema:
588
        schema:
589
          $ref: ../definitions.yaml#/error
589
          $ref: "../swagger.yaml#/definitions/error"
590
    x-koha-authorization:
590
    x-koha-authorization:
591
      permissions:
591
      permissions:
592
        borrowers: delete_borrowers
592
        borrowers: delete_borrowers
(-)a/api/v1/swagger/paths/patrons_account.yaml (-15 / +15 lines)
Lines 7-43 Link Here
7
      - patrons
7
      - patrons
8
    summary: Get account information for a patron
8
    summary: Get account information for a patron
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_pp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
11
    produces:
11
    produces:
12
      - application/json
12
      - application/json
13
    responses:
13
    responses:
14
      "200":
14
      "200":
15
        description: Patron's account balance
15
        description: Patron's account balance
16
        schema:
16
        schema:
17
          $ref: ../definitions.yaml#/patron_balance
17
          $ref: "../swagger.yaml#/definitions/patron_balance"
18
      "401":
18
      "401":
19
        description: Authentication required
19
        description: Authentication required
20
        schema:
20
        schema:
21
          $ref: ../definitions.yaml#/error
21
          $ref: "../swagger.yaml#/definitions/error"
22
      "403":
22
      "403":
23
        description: Access forbidden
23
        description: Access forbidden
24
        schema:
24
        schema:
25
          $ref: ../definitions.yaml#/error
25
          $ref: "../swagger.yaml#/definitions/error"
26
      "404":
26
      "404":
27
        description: Patron not found
27
        description: Patron not found
28
        schema:
28
        schema:
29
          $ref: ../definitions.yaml#/error
29
          $ref: "../swagger.yaml#/definitions/error"
30
      "500":
30
      "500":
31
        description: |
31
        description: |
32
          Internal server error. Possible `error_code` attribute values:
32
          Internal server error. Possible `error_code` attribute values:
33
33
34
          * `internal_server_error`
34
          * `internal_server_error`
35
        schema:
35
        schema:
36
          $ref: ../definitions.yaml#/error
36
          $ref: "../swagger.yaml#/definitions/error"
37
      "503":
37
      "503":
38
        description: Under maintenance
38
        description: Under maintenance
39
        schema:
39
        schema:
40
          $ref: ../definitions.yaml#/error
40
          $ref: "../swagger.yaml#/definitions/error"
41
    x-koha-authorization:
41
    x-koha-authorization:
42
      permissions:
42
      permissions:
43
        borrowers: edit_borrowers
43
        borrowers: edit_borrowers
Lines 50-92 Link Here
50
      - patrons
50
      - patrons
51
    summary: Add credit to a patron's account
51
    summary: Add credit to a patron's account
52
    parameters:
52
    parameters:
53
      - $ref: ../parameters.yaml#/patron_id_pp
53
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
54
      - name: body
54
      - name: body
55
        in: body
55
        in: body
56
        description: A JSON object containing credit information
56
        description: A JSON object containing credit information
57
        required: true
57
        required: true
58
        schema:
58
        schema:
59
          $ref: ../definitions.yaml#/patron_account_credit
59
          $ref: "../swagger.yaml#/definitions/patron_account_credit"
60
    produces:
60
    produces:
61
      - application/json
61
      - application/json
62
    responses:
62
    responses:
63
      "201":
63
      "201":
64
        description: Credit added
64
        description: Credit added
65
        schema:
65
        schema:
66
          $ref: ../definitions.yaml#/account_line
66
          $ref: "../swagger.yaml#/definitions/account_line"
67
      "401":
67
      "401":
68
        description: Authentication required
68
        description: Authentication required
69
        schema:
69
        schema:
70
          $ref: ../definitions.yaml#/error
70
          $ref: "../swagger.yaml#/definitions/error"
71
      "403":
71
      "403":
72
        description: Access forbidden
72
        description: Access forbidden
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/error
74
          $ref: "../swagger.yaml#/definitions/error"
75
      "404":
75
      "404":
76
        description: Patron not found
76
        description: Patron not found
77
        schema:
77
        schema:
78
          $ref: ../definitions.yaml#/error
78
          $ref: "../swagger.yaml#/definitions/error"
79
      "500":
79
      "500":
80
        description: |
80
        description: |
81
          Internal server error. Possible `error_code` attribute values:
81
          Internal server error. Possible `error_code` attribute values:
82
82
83
          * `internal_server_error`
83
          * `internal_server_error`
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
      "503":
86
      "503":
87
        description: Under maintenance
87
        description: Under maintenance
88
        schema:
88
        schema:
89
          $ref: ../definitions.yaml#/error
89
          $ref: "../swagger.yaml#/definitions/error"
90
    x-koha-authorization:
90
    x-koha-authorization:
91
      permissions:
91
      permissions:
92
        updatecharges: remaining_permissions
92
        updatecharges: remaining_permissions
(-)a/api/v1/swagger/paths/patrons_extended_attributes.yaml (-49 / +49 lines)
Lines 7-20 Link Here
7
      - patrons
7
      - patrons
8
    summary: List extended attributes for a patron
8
    summary: List extended attributes for a patron
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_pp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
11
      - $ref: ../parameters.yaml#/match
11
      - $ref: "../swagger.yaml#/parameters/match"
12
      - $ref: ../parameters.yaml#/order_by
12
      - $ref: "../swagger.yaml#/parameters/order_by"
13
      - $ref: ../parameters.yaml#/page
13
      - $ref: "../swagger.yaml#/parameters/page"
14
      - $ref: ../parameters.yaml#/per_page
14
      - $ref: "../swagger.yaml#/parameters/per_page"
15
      - $ref: ../parameters.yaml#/q_param
15
      - $ref: "../swagger.yaml#/parameters/q_param"
16
      - $ref: ../parameters.yaml#/q_body
16
      - $ref: "../swagger.yaml#/parameters/q_body"
17
      - $ref: ../parameters.yaml#/q_header
17
      - $ref: "../swagger.yaml#/parameters/q_header"
18
    produces:
18
    produces:
19
      - application/json
19
      - application/json
20
    responses:
20
    responses:
Lines 23-52 Link Here
23
        schema:
23
        schema:
24
          type: array
24
          type: array
25
          items:
25
          items:
26
            $ref: ../definitions.yaml#/patron_extended_attribute
26
            $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
27
      "401":
27
      "401":
28
        description: Authentication required
28
        description: Authentication required
29
        schema:
29
        schema:
30
          $ref: ../definitions.yaml#/error
30
          $ref: "../swagger.yaml#/definitions/error"
31
      "403":
31
      "403":
32
        description: Access forbidden
32
        description: Access forbidden
33
        schema:
33
        schema:
34
          $ref: ../definitions.yaml#/error
34
          $ref: "../swagger.yaml#/definitions/error"
35
      "404":
35
      "404":
36
        description: Patron not found
36
        description: Patron not found
37
        schema:
37
        schema:
38
          $ref: ../definitions.yaml#/error
38
          $ref: "../swagger.yaml#/definitions/error"
39
      "500":
39
      "500":
40
        description: |
40
        description: |
41
          Internal server error. Possible `error_code` attribute values:
41
          Internal server error. Possible `error_code` attribute values:
42
42
43
          * `internal_server_error`
43
          * `internal_server_error`
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "503":
46
      "503":
47
        description: Under maintenance
47
        description: Under maintenance
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
    x-koha-authorization:
50
    x-koha-authorization:
51
      permissions:
51
      permissions:
52
        borrowers: edit_borrowers
52
        borrowers: edit_borrowers
Lines 57-107 Link Here
57
      - patrons
57
      - patrons
58
    summary: Add extended attribute for a patron
58
    summary: Add extended attribute for a patron
59
    parameters:
59
    parameters:
60
      - $ref: ../parameters.yaml#/patron_id_pp
60
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
61
      - name: body
61
      - name: body
62
        in: body
62
        in: body
63
        description: A JSON representation of the patron extended attribute
63
        description: A JSON representation of the patron extended attribute
64
        required: true
64
        required: true
65
        schema:
65
        schema:
66
          $ref: ../definitions.yaml#/patron_extended_attribute
66
          $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
67
    produces:
67
    produces:
68
      - application/json
68
      - application/json
69
    responses:
69
    responses:
70
      "201":
70
      "201":
71
        description: A successfully created patron extended attribute
71
        description: A successfully created patron extended attribute
72
        schema:
72
        schema:
73
          $ref: ../definitions.yaml#/patron_extended_attribute
73
          $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
74
      "400":
74
      "400":
75
        description: Bad parameter
75
        description: Bad parameter
76
        schema:
76
        schema:
77
          $ref: ../definitions.yaml#/error
77
          $ref: "../swagger.yaml#/definitions/error"
78
      "401":
78
      "401":
79
        description: Authentication required
79
        description: Authentication required
80
        schema:
80
        schema:
81
          $ref: ../definitions.yaml#/error
81
          $ref: "../swagger.yaml#/definitions/error"
82
      "403":
82
      "403":
83
        description: Access forbidden
83
        description: Access forbidden
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
      "404":
86
      "404":
87
        description: Patron not found
87
        description: Patron not found
88
        schema:
88
        schema:
89
          $ref: ../definitions.yaml#/error
89
          $ref: "../swagger.yaml#/definitions/error"
90
      "409":
90
      "409":
91
        description: Conflict in creating resource
91
        description: Conflict in creating resource
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/error
93
          $ref: "../swagger.yaml#/definitions/error"
94
      "500":
94
      "500":
95
        description: |
95
        description: |
96
          Internal server error. Possible `error_code` attribute values:
96
          Internal server error. Possible `error_code` attribute values:
97
97
98
          * `internal_server_error`
98
          * `internal_server_error`
99
        schema:
99
        schema:
100
          $ref: ../definitions.yaml#/error
100
          $ref: "../swagger.yaml#/definitions/error"
101
      "503":
101
      "503":
102
        description: Under maintenance
102
        description: Under maintenance
103
        schema:
103
        schema:
104
          $ref: ../definitions.yaml#/error
104
          $ref: "../swagger.yaml#/definitions/error"
105
    x-koha-authorization:
105
    x-koha-authorization:
106
      permissions:
106
      permissions:
107
        borrowers: edit_borrowers
107
        borrowers: edit_borrowers
Lines 112-118 Link Here
112
      - patrons
112
      - patrons
113
    summary: Overwrite extended attributes for a patron
113
    summary: Overwrite extended attributes for a patron
114
    parameters:
114
    parameters:
115
      - $ref: ../parameters.yaml#/patron_id_pp
115
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
116
      - name: body
116
      - name: body
117
        in: body
117
        in: body
118
        description: A JSON representation of the patron extended attribute
118
        description: A JSON representation of the patron extended attribute
Lines 120-126 Link Here
120
        schema:
120
        schema:
121
          type: array
121
          type: array
122
          items:
122
          items:
123
            $ref: ../definitions.yaml#/patron_extended_attribute
123
            $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
124
    produces:
124
    produces:
125
      - application/json
125
      - application/json
126
    responses:
126
    responses:
Lines 129-166 Link Here
129
        schema:
129
        schema:
130
          type: array
130
          type: array
131
          items:
131
          items:
132
            $ref: ../definitions.yaml#/patron_extended_attribute
132
            $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
133
      "400":
133
      "400":
134
        description: Bad parameters
134
        description: Bad parameters
135
        schema:
135
        schema:
136
          $ref: ../definitions.yaml#/error
136
          $ref: "../swagger.yaml#/definitions/error"
137
      "401":
137
      "401":
138
        description: Authentication required
138
        description: Authentication required
139
        schema:
139
        schema:
140
          $ref: ../definitions.yaml#/error
140
          $ref: "../swagger.yaml#/definitions/error"
141
      "403":
141
      "403":
142
        description: Access forbidden
142
        description: Access forbidden
143
        schema:
143
        schema:
144
          $ref: ../definitions.yaml#/error
144
          $ref: "../swagger.yaml#/definitions/error"
145
      "404":
145
      "404":
146
        description: Patron not found
146
        description: Patron not found
147
        schema:
147
        schema:
148
          $ref: ../definitions.yaml#/error
148
          $ref: "../swagger.yaml#/definitions/error"
149
      "409":
149
      "409":
150
        description: Conflict in creating resource
150
        description: Conflict in creating resource
151
        schema:
151
        schema:
152
          $ref: ../definitions.yaml#/error
152
          $ref: "../swagger.yaml#/definitions/error"
153
      "500":
153
      "500":
154
        description: |
154
        description: |
155
          Internal server error. Possible `error_code` attribute values:
155
          Internal server error. Possible `error_code` attribute values:
156
156
157
          * `internal_server_error`
157
          * `internal_server_error`
158
        schema:
158
        schema:
159
          $ref: ../definitions.yaml#/error
159
          $ref: "../swagger.yaml#/definitions/error"
160
      "503":
160
      "503":
161
        description: Under maintenance
161
        description: Under maintenance
162
        schema:
162
        schema:
163
          $ref: ../definitions.yaml#/error
163
          $ref: "../swagger.yaml#/definitions/error"
164
    x-koha-authorization:
164
    x-koha-authorization:
165
      permissions:
165
      permissions:
166
        borrowers: edit_borrowers
166
        borrowers: edit_borrowers
Lines 172-178 Link Here
172
      - patrons
172
      - patrons
173
    summary: Update extended attribute
173
    summary: Update extended attribute
174
    parameters:
174
    parameters:
175
      - $ref: ../parameters.yaml#/patron_id_pp
175
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
176
      - name: extended_attribute_id
176
      - name: extended_attribute_id
177
        in: path
177
        in: path
178
        description: Internal patron extended attribute identifier
178
        description: Internal patron extended attribute identifier
Lines 196-233 Link Here
196
      "200":
196
      "200":
197
        description: A successfully updated patron extended attribute
197
        description: A successfully updated patron extended attribute
198
        schema:
198
        schema:
199
          $ref: ../definitions.yaml#/patron_extended_attribute
199
          $ref: "../swagger.yaml#/definitions/patron_extended_attribute"
200
      "400":
200
      "400":
201
        description: Bad parameter
201
        description: Bad parameter
202
        schema:
202
        schema:
203
          $ref: ../definitions.yaml#/error
203
          $ref: "../swagger.yaml#/definitions/error"
204
      "401":
204
      "401":
205
        description: Authentication required
205
        description: Authentication required
206
        schema:
206
        schema:
207
          $ref: ../definitions.yaml#/error
207
          $ref: "../swagger.yaml#/definitions/error"
208
      "403":
208
      "403":
209
        description: Access forbidden
209
        description: Access forbidden
210
        schema:
210
        schema:
211
          $ref: ../definitions.yaml#/error
211
          $ref: "../swagger.yaml#/definitions/error"
212
      "404":
212
      "404":
213
        description: Object not found
213
        description: Object not found
214
        schema:
214
        schema:
215
          $ref: ../definitions.yaml#/error
215
          $ref: "../swagger.yaml#/definitions/error"
216
      "409":
216
      "409":
217
        description: Conflict in updating resource
217
        description: Conflict in updating resource
218
        schema:
218
        schema:
219
          $ref: ../definitions.yaml#/error
219
          $ref: "../swagger.yaml#/definitions/error"
220
      "500":
220
      "500":
221
        description: |
221
        description: |
222
          Internal server error. Possible `error_code` attribute values:
222
          Internal server error. Possible `error_code` attribute values:
223
223
224
          * `internal_server_error`
224
          * `internal_server_error`
225
        schema:
225
        schema:
226
          $ref: ../definitions.yaml#/error
226
          $ref: "../swagger.yaml#/definitions/error"
227
      "503":
227
      "503":
228
        description: Under maintenance
228
        description: Under maintenance
229
        schema:
229
        schema:
230
          $ref: ../definitions.yaml#/error
230
          $ref: "../swagger.yaml#/definitions/error"
231
    x-koha-authorization:
231
    x-koha-authorization:
232
      permissions:
232
      permissions:
233
        borrowers: edit_borrowers
233
        borrowers: edit_borrowers
Lines 238-244 Link Here
238
      - patrons
238
      - patrons
239
    summary: Delete extended attribute
239
    summary: Delete extended attribute
240
    parameters:
240
    parameters:
241
      - $ref: ../parameters.yaml#/patron_id_pp
241
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
242
      - name: extended_attribute_id
242
      - name: extended_attribute_id
243
        in: path
243
        in: path
244
        description: Internal patron extended attribute identifier
244
        description: Internal patron extended attribute identifier
Lines 252-277 Link Here
252
      "401":
252
      "401":
253
        description: Authentication required
253
        description: Authentication required
254
        schema:
254
        schema:
255
          $ref: ../definitions.yaml#/error
255
          $ref: "../swagger.yaml#/definitions/error"
256
      "403":
256
      "403":
257
        description: Access forbidden
257
        description: Access forbidden
258
        schema:
258
        schema:
259
          $ref: ../definitions.yaml#/error
259
          $ref: "../swagger.yaml#/definitions/error"
260
      "404":
260
      "404":
261
        description: Patron not found
261
        description: Patron not found
262
        schema:
262
        schema:
263
          $ref: ../definitions.yaml#/error
263
          $ref: "../swagger.yaml#/definitions/error"
264
      "500":
264
      "500":
265
        description: |
265
        description: |
266
          Internal server error. Possible `error_code` attribute values:
266
          Internal server error. Possible `error_code` attribute values:
267
267
268
          * `internal_server_error`
268
          * `internal_server_error`
269
        schema:
269
        schema:
270
          $ref: ../definitions.yaml#/error
270
          $ref: "../swagger.yaml#/definitions/error"
271
      "503":
271
      "503":
272
        description: Under maintenance
272
        description: Under maintenance
273
        schema:
273
        schema:
274
          $ref: ../definitions.yaml#/error
274
          $ref: "../swagger.yaml#/definitions/error"
275
    x-koha-authorization:
275
    x-koha-authorization:
276
      permissions:
276
      permissions:
277
        borrowers: edit_borrowers
277
        borrowers: edit_borrowers
(-)a/api/v1/swagger/paths/patrons_holds.yaml (-14 / +14 lines)
Lines 7-20 Link Here
7
      - holds
7
      - holds
8
    summary: List holds for a patron
8
    summary: List holds for a patron
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_pp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
11
      - $ref: ../parameters.yaml#/match
11
      - $ref: "../swagger.yaml#/parameters/match"
12
      - $ref: ../parameters.yaml#/order_by
12
      - $ref: "../swagger.yaml#/parameters/order_by"
13
      - $ref: ../parameters.yaml#/page
13
      - $ref: "../swagger.yaml#/parameters/page"
14
      - $ref: ../parameters.yaml#/per_page
14
      - $ref: "../swagger.yaml#/parameters/per_page"
15
      - $ref: ../parameters.yaml#/q_param
15
      - $ref: "../swagger.yaml#/parameters/q_param"
16
      - $ref: ../parameters.yaml#/q_body
16
      - $ref: "../swagger.yaml#/parameters/q_body"
17
      - $ref: ../parameters.yaml#/q_header
17
      - $ref: "../swagger.yaml#/parameters/q_header"
18
    produces:
18
    produces:
19
      - application/json
19
      - application/json
20
    responses:
20
    responses:
Lines 23-52 Link Here
23
        schema:
23
        schema:
24
          type: array
24
          type: array
25
          items:
25
          items:
26
            $ref: ../definitions.yaml#/hold
26
            $ref: "../swagger.yaml#/definitions/hold"
27
      "401":
27
      "401":
28
        description: Authentication required
28
        description: Authentication required
29
        schema:
29
        schema:
30
          $ref: ../definitions.yaml#/error
30
          $ref: "../swagger.yaml#/definitions/error"
31
      "403":
31
      "403":
32
        description: Access forbidden
32
        description: Access forbidden
33
        schema:
33
        schema:
34
          $ref: ../definitions.yaml#/error
34
          $ref: "../swagger.yaml#/definitions/error"
35
      "404":
35
      "404":
36
        description: Patron not found
36
        description: Patron not found
37
        schema:
37
        schema:
38
          $ref: ../definitions.yaml#/error
38
          $ref: "../swagger.yaml#/definitions/error"
39
      "500":
39
      "500":
40
        description: |
40
        description: |
41
          Internal server error. Possible `error_code` attribute values:
41
          Internal server error. Possible `error_code` attribute values:
42
42
43
          * `internal_server_error`
43
          * `internal_server_error`
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "503":
46
      "503":
47
        description: Under maintenance
47
        description: Under maintenance
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
    x-koha-authorization:
50
    x-koha-authorization:
51
      permissions:
51
      permissions:
52
        borrowers: edit_borrowers
52
        borrowers: edit_borrowers
(-)a/api/v1/swagger/paths/patrons_password.yaml (-7 / +7 lines)
Lines 7-13 Link Here
7
      - patrons
7
      - patrons
8
    summary: Set password for a patron
8
    summary: Set password for a patron
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_pp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
11
      - name: body
11
      - name: body
12
        in: body
12
        in: body
13
        description: A JSON object containing password information
13
        description: A JSON object containing password information
Lines 32-61 Link Here
32
      "400":
32
      "400":
33
        description: Bad request
33
        description: Bad request
34
        schema:
34
        schema:
35
          $ref: ../definitions.yaml#/error
35
          $ref: "../swagger.yaml#/definitions/error"
36
      "401":
36
      "401":
37
        description: Authentication required
37
        description: Authentication required
38
        schema:
38
        schema:
39
          $ref: ../definitions.yaml#/error
39
          $ref: "../swagger.yaml#/definitions/error"
40
      "403":
40
      "403":
41
        description: Access forbidden
41
        description: Access forbidden
42
        schema:
42
        schema:
43
          $ref: ../definitions.yaml#/error
43
          $ref: "../swagger.yaml#/definitions/error"
44
      "404":
44
      "404":
45
        description: Patron not found
45
        description: Patron not found
46
        schema:
46
        schema:
47
          $ref: ../definitions.yaml#/error
47
          $ref: "../swagger.yaml#/definitions/error"
48
      "500":
48
      "500":
49
        description: |
49
        description: |
50
          Internal server error. Possible `error_code` attribute values:
50
          Internal server error. Possible `error_code` attribute values:
51
51
52
          * `internal_server_error`
52
          * `internal_server_error`
53
        schema:
53
        schema:
54
          $ref: ../definitions.yaml#/error
54
          $ref: "../swagger.yaml#/definitions/error"
55
      "503":
55
      "503":
56
        description: Under maintenance
56
        description: Under maintenance
57
        schema:
57
        schema:
58
          $ref: ../definitions.yaml#/error
58
          $ref: "../swagger.yaml#/definitions/error"
59
    x-koha-authorization:
59
    x-koha-authorization:
60
      permissions:
60
      permissions:
61
        borrowers: "1"
61
        borrowers: "1"
(-)a/api/v1/swagger/paths/public_patrons.yaml (-21 / +21 lines)
Lines 7-13 Link Here
7
      - patrons
7
      - patrons
8
    summary: Set password for a patron (public)
8
    summary: Set password for a patron (public)
9
    parameters:
9
    parameters:
10
      - $ref: ../parameters.yaml#/patron_id_pp
10
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
11
      - name: body
11
      - name: body
12
        in: body
12
        in: body
13
        description: A JSON object containing password information
13
        description: A JSON object containing password information
Lines 36-65 Link Here
36
      "400":
36
      "400":
37
        description: Bad request
37
        description: Bad request
38
        schema:
38
        schema:
39
          $ref: ../definitions.yaml#/error
39
          $ref: "../swagger.yaml#/definitions/error"
40
      "401":
40
      "401":
41
        description: Authentication required
41
        description: Authentication required
42
        schema:
42
        schema:
43
          $ref: ../definitions.yaml#/error
43
          $ref: "../swagger.yaml#/definitions/error"
44
      "403":
44
      "403":
45
        description: Access forbidden
45
        description: Access forbidden
46
        schema:
46
        schema:
47
          $ref: ../definitions.yaml#/error
47
          $ref: "../swagger.yaml#/definitions/error"
48
      "404":
48
      "404":
49
        description: Patron not found
49
        description: Patron not found
50
        schema:
50
        schema:
51
          $ref: ../definitions.yaml#/error
51
          $ref: "../swagger.yaml#/definitions/error"
52
      "500":
52
      "500":
53
        description: |
53
        description: |
54
          Internal server error. Possible `error_code` attribute values:
54
          Internal server error. Possible `error_code` attribute values:
55
55
56
          * `internal_server_error`
56
          * `internal_server_error`
57
        schema:
57
        schema:
58
          $ref: ../definitions.yaml#/error
58
          $ref: "../swagger.yaml#/definitions/error"
59
      "503":
59
      "503":
60
        description: Under maintenance
60
        description: Under maintenance
61
        schema:
61
        schema:
62
          $ref: ../definitions.yaml#/error
62
          $ref: "../swagger.yaml#/definitions/error"
63
    x-koha-authorization:
63
    x-koha-authorization:
64
      allow-owner: true
64
      allow-owner: true
65
"/public/patrons/{patron_id}/guarantors/can_see_charges":
65
"/public/patrons/{patron_id}/guarantors/can_see_charges":
Lines 70-76 Link Here
70
      - patrons
70
      - patrons
71
    summary: Set if guarantors can see charges (public)
71
    summary: Set if guarantors can see charges (public)
72
    parameters:
72
    parameters:
73
      - $ref: ../parameters.yaml#/patron_id_pp
73
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
74
      - name: body
74
      - name: body
75
        in: body
75
        in: body
76
        description: A boolean representing if guarantors should be able to see the
76
        description: A boolean representing if guarantors should be able to see the
Lines 90-119 Link Here
90
      "400":
90
      "400":
91
        description: Bad request
91
        description: Bad request
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/error
93
          $ref: "../swagger.yaml#/definitions/error"
94
      "401":
94
      "401":
95
        description: Authentication required
95
        description: Authentication required
96
        schema:
96
        schema:
97
          $ref: ../definitions.yaml#/error
97
          $ref: "../swagger.yaml#/definitions/error"
98
      "403":
98
      "403":
99
        description: Access forbidden
99
        description: Access forbidden
100
        schema:
100
        schema:
101
          $ref: ../definitions.yaml#/error
101
          $ref: "../swagger.yaml#/definitions/error"
102
      "404":
102
      "404":
103
        description: Patron not found
103
        description: Patron not found
104
        schema:
104
        schema:
105
          $ref: ../definitions.yaml#/error
105
          $ref: "../swagger.yaml#/definitions/error"
106
      "500":
106
      "500":
107
        description: |
107
        description: |
108
          Internal server error. Possible `error_code` attribute values:
108
          Internal server error. Possible `error_code` attribute values:
109
109
110
          * `internal_server_error`
110
          * `internal_server_error`
111
        schema:
111
        schema:
112
          $ref: ../definitions.yaml#/error
112
          $ref: "../swagger.yaml#/definitions/error"
113
      "503":
113
      "503":
114
        description: Under maintenance
114
        description: Under maintenance
115
        schema:
115
        schema:
116
          $ref: ../definitions.yaml#/error
116
          $ref: "../swagger.yaml#/definitions/error"
117
    x-koha-authorization:
117
    x-koha-authorization:
118
      allow-owner: true
118
      allow-owner: true
119
"/public/patrons/{patron_id}/guarantors/can_see_checkouts":
119
"/public/patrons/{patron_id}/guarantors/can_see_checkouts":
Lines 124-130 Link Here
124
      - patrons
124
      - patrons
125
    summary: Set if guarantors can see checkouts
125
    summary: Set if guarantors can see checkouts
126
    parameters:
126
    parameters:
127
      - $ref: ../parameters.yaml#/patron_id_pp
127
      - $ref: "../swagger.yaml#/parameters/patron_id_pp"
128
      - name: body
128
      - name: body
129
        in: body
129
        in: body
130
        description: A boolean representing if guarantors should be able to see the
130
        description: A boolean representing if guarantors should be able to see the
Lines 144-172 Link Here
144
      "400":
144
      "400":
145
        description: Bad request
145
        description: Bad request
146
        schema:
146
        schema:
147
          $ref: ../definitions.yaml#/error
147
          $ref: "../swagger.yaml#/definitions/error"
148
      "401":
148
      "401":
149
        description: Authentication required
149
        description: Authentication required
150
        schema:
150
        schema:
151
          $ref: ../definitions.yaml#/error
151
          $ref: "../swagger.yaml#/definitions/error"
152
      "403":
152
      "403":
153
        description: Access forbidden
153
        description: Access forbidden
154
        schema:
154
        schema:
155
          $ref: ../definitions.yaml#/error
155
          $ref: "../swagger.yaml#/definitions/error"
156
      "404":
156
      "404":
157
        description: Patron not found
157
        description: Patron not found
158
        schema:
158
        schema:
159
          $ref: ../definitions.yaml#/error
159
          $ref: "../swagger.yaml#/definitions/error"
160
      "500":
160
      "500":
161
        description: |
161
        description: |
162
          Internal server error. Possible `error_code` attribute values:
162
          Internal server error. Possible `error_code` attribute values:
163
163
164
          * `internal_server_error`
164
          * `internal_server_error`
165
        schema:
165
        schema:
166
          $ref: ../definitions.yaml#/error
166
          $ref: "../swagger.yaml#/definitions/error"
167
      "503":
167
      "503":
168
        description: Under maintenance
168
        description: Under maintenance
169
        schema:
169
        schema:
170
          $ref: ../definitions.yaml#/error
170
          $ref: "../swagger.yaml#/definitions/error"
171
    x-koha-authorization:
171
    x-koha-authorization:
172
      allow-owner: true
172
      allow-owner: true
(-)a/api/v1/swagger/paths/quotes.yaml (-36 / +36 lines)
Lines 29-63 Link Here
29
        description: Case Insensative search on last displayed date
29
        description: Case Insensative search on last displayed date
30
        required: false
30
        required: false
31
        type: string
31
        type: string
32
      - $ref: ../parameters.yaml#/match
32
      - $ref: "../swagger.yaml#/parameters/match"
33
      - $ref: ../parameters.yaml#/order_by
33
      - $ref: "../swagger.yaml#/parameters/order_by"
34
      - $ref: ../parameters.yaml#/page
34
      - $ref: "../swagger.yaml#/parameters/page"
35
      - $ref: ../parameters.yaml#/per_page
35
      - $ref: "../swagger.yaml#/parameters/per_page"
36
      - $ref: ../parameters.yaml#/q_param
36
      - $ref: "../swagger.yaml#/parameters/q_param"
37
      - $ref: ../parameters.yaml#/q_body
37
      - $ref: "../swagger.yaml#/parameters/q_body"
38
      - $ref: ../parameters.yaml#/q_header
38
      - $ref: "../swagger.yaml#/parameters/q_header"
39
    responses:
39
    responses:
40
      "200":
40
      "200":
41
        description: A list of quotes
41
        description: A list of quotes
42
        schema:
42
        schema:
43
          type: array
43
          type: array
44
          items:
44
          items:
45
            $ref: ../definitions.yaml#/quote
45
            $ref: "../swagger.yaml#/definitions/quote"
46
      "403":
46
      "403":
47
        description: Access forbidden
47
        description: Access forbidden
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
      "500":
50
      "500":
51
        description: |
51
        description: |
52
          Internal server error. Possible `error_code` attribute values:
52
          Internal server error. Possible `error_code` attribute values:
53
53
54
          * `internal_server_error`
54
          * `internal_server_error`
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/error
56
          $ref: "../swagger.yaml#/definitions/error"
57
      "503":
57
      "503":
58
        description: Under maintenance
58
        description: Under maintenance
59
        schema:
59
        schema:
60
          $ref: ../definitions.yaml#/error
60
          $ref: "../swagger.yaml#/definitions/error"
61
    x-koha-authorization:
61
    x-koha-authorization:
62
      permissions:
62
      permissions:
63
        catalogue: "1"
63
        catalogue: "1"
Lines 73-105 Link Here
73
        description: A JSON object containing informations about the new quote
73
        description: A JSON object containing informations about the new quote
74
        required: true
74
        required: true
75
        schema:
75
        schema:
76
          $ref: ../definitions.yaml#/quote
76
          $ref: "../swagger.yaml#/definitions/quote"
77
    produces:
77
    produces:
78
      - application/json
78
      - application/json
79
    responses:
79
    responses:
80
      "201":
80
      "201":
81
        description: Quote added
81
        description: Quote added
82
        schema:
82
        schema:
83
          $ref: ../definitions.yaml#/quote
83
          $ref: "../swagger.yaml#/definitions/quote"
84
      "401":
84
      "401":
85
        description: Authentication required
85
        description: Authentication required
86
        schema:
86
        schema:
87
          $ref: ../definitions.yaml#/error
87
          $ref: "../swagger.yaml#/definitions/error"
88
      "403":
88
      "403":
89
        description: Access forbidden
89
        description: Access forbidden
90
        schema:
90
        schema:
91
          $ref: ../definitions.yaml#/error
91
          $ref: "../swagger.yaml#/definitions/error"
92
      "500":
92
      "500":
93
        description: |
93
        description: |
94
          Internal server error. Possible `error_code` attribute values:
94
          Internal server error. Possible `error_code` attribute values:
95
95
96
          * `internal_server_error`
96
          * `internal_server_error`
97
        schema:
97
        schema:
98
          $ref: ../definitions.yaml#/error
98
          $ref: "../swagger.yaml#/definitions/error"
99
      "503":
99
      "503":
100
        description: Under maintenance
100
        description: Under maintenance
101
        schema:
101
        schema:
102
          $ref: ../definitions.yaml#/error
102
          $ref: "../swagger.yaml#/definitions/error"
103
    x-koha-authorization:
103
    x-koha-authorization:
104
      permissions:
104
      permissions:
105
        tools: edit_quotes
105
        tools: edit_quotes
Lines 111-139 Link Here
111
      - quotes
111
      - quotes
112
    summary: Get quote
112
    summary: Get quote
113
    parameters:
113
    parameters:
114
      - $ref: ../parameters.yaml#/quote_id_pp
114
      - $ref: "../swagger.yaml#/parameters/quote_id_pp"
115
    produces:
115
    produces:
116
      - application/json
116
      - application/json
117
    responses:
117
    responses:
118
      "200":
118
      "200":
119
        description: A Quote
119
        description: A Quote
120
        schema:
120
        schema:
121
          $ref: ../definitions.yaml#/quote
121
          $ref: "../swagger.yaml#/definitions/quote"
122
      "404":
122
      "404":
123
        description: Quote not found
123
        description: Quote not found
124
        schema:
124
        schema:
125
          $ref: ../definitions.yaml#/error
125
          $ref: "../swagger.yaml#/definitions/error"
126
      "500":
126
      "500":
127
        description: |
127
        description: |
128
          Internal server error. Possible `error_code` attribute values:
128
          Internal server error. Possible `error_code` attribute values:
129
129
130
          * `internal_server_error`
130
          * `internal_server_error`
131
        schema:
131
        schema:
132
          $ref: ../definitions.yaml#/error
132
          $ref: "../swagger.yaml#/definitions/error"
133
      "503":
133
      "503":
134
        description: Under maintenance
134
        description: Under maintenance
135
        schema:
135
        schema:
136
          $ref: ../definitions.yaml#/error
136
          $ref: "../swagger.yaml#/definitions/error"
137
    x-koha-authorization:
137
    x-koha-authorization:
138
      permissions:
138
      permissions:
139
        catalogue: "1"
139
        catalogue: "1"
Lines 144-186 Link Here
144
      - quotes
144
      - quotes
145
    summary: Update quote
145
    summary: Update quote
146
    parameters:
146
    parameters:
147
      - $ref: ../parameters.yaml#/quote_id_pp
147
      - $ref: "../swagger.yaml#/parameters/quote_id_pp"
148
      - name: body
148
      - name: body
149
        in: body
149
        in: body
150
        description: a quote object
150
        description: a quote object
151
        required: true
151
        required: true
152
        schema:
152
        schema:
153
          $ref: ../definitions.yaml#/quote
153
          $ref: "../swagger.yaml#/definitions/quote"
154
    produces:
154
    produces:
155
      - application/json
155
      - application/json
156
    responses:
156
    responses:
157
      "200":
157
      "200":
158
        description: A quote
158
        description: A quote
159
        schema:
159
        schema:
160
          $ref: ../definitions.yaml#/quote
160
          $ref: "../swagger.yaml#/definitions/quote"
161
      "401":
161
      "401":
162
        description: Authentication required
162
        description: Authentication required
163
        schema:
163
        schema:
164
          $ref: ../definitions.yaml#/error
164
          $ref: "../swagger.yaml#/definitions/error"
165
      "403":
165
      "403":
166
        description: Access forbidden
166
        description: Access forbidden
167
        schema:
167
        schema:
168
          $ref: ../definitions.yaml#/error
168
          $ref: "../swagger.yaml#/definitions/error"
169
      "404":
169
      "404":
170
        description: Quote not found
170
        description: Quote not found
171
        schema:
171
        schema:
172
          $ref: ../definitions.yaml#/error
172
          $ref: "../swagger.yaml#/definitions/error"
173
      "500":
173
      "500":
174
        description: |
174
        description: |
175
          Internal server error. Possible `error_code` attribute values:
175
          Internal server error. Possible `error_code` attribute values:
176
176
177
          * `internal_server_error`
177
          * `internal_server_error`
178
        schema:
178
        schema:
179
          $ref: ../definitions.yaml#/error
179
          $ref: "../swagger.yaml#/definitions/error"
180
      "503":
180
      "503":
181
        description: Under maintenance
181
        description: Under maintenance
182
        schema:
182
        schema:
183
          $ref: ../definitions.yaml#/error
183
          $ref: "../swagger.yaml#/definitions/error"
184
    x-koha-authorization:
184
    x-koha-authorization:
185
      permissions:
185
      permissions:
186
        tools: edit_quotes
186
        tools: edit_quotes
Lines 191-197 Link Here
191
      - quotes
191
      - quotes
192
    summary: Delete quote
192
    summary: Delete quote
193
    parameters:
193
    parameters:
194
      - $ref: ../parameters.yaml#/quote_id_pp
194
      - $ref: "../swagger.yaml#/parameters/quote_id_pp"
195
    produces:
195
    produces:
196
      - application/json
196
      - application/json
197
    responses:
197
    responses:
Lines 200-225 Link Here
200
      "401":
200
      "401":
201
        description: Authentication required
201
        description: Authentication required
202
        schema:
202
        schema:
203
          $ref: ../definitions.yaml#/error
203
          $ref: "../swagger.yaml#/definitions/error"
204
      "403":
204
      "403":
205
        description: Access forbidden
205
        description: Access forbidden
206
        schema:
206
        schema:
207
          $ref: ../definitions.yaml#/error
207
          $ref: "../swagger.yaml#/definitions/error"
208
      "404":
208
      "404":
209
        description: Quote not found
209
        description: Quote not found
210
        schema:
210
        schema:
211
          $ref: ../definitions.yaml#/error
211
          $ref: "../swagger.yaml#/definitions/error"
212
      "500":
212
      "500":
213
        description: |
213
        description: |
214
          Internal server error. Possible `error_code` attribute values:
214
          Internal server error. Possible `error_code` attribute values:
215
215
216
          * `internal_server_error`
216
          * `internal_server_error`
217
        schema:
217
        schema:
218
          $ref: ../definitions.yaml#/error
218
          $ref: "../swagger.yaml#/definitions/error"
219
      "503":
219
      "503":
220
        description: Under maintenance
220
        description: Under maintenance
221
        schema:
221
        schema:
222
          $ref: ../definitions.yaml#/error
222
          $ref: "../swagger.yaml#/definitions/error"
223
    x-koha-authorization:
223
    x-koha-authorization:
224
      permissions:
224
      permissions:
225
        tools: edit_quotes
225
        tools: edit_quotes
(-)a/api/v1/swagger/paths/return_claims.yaml (-29 / +29 lines)
Lines 34-71 Link Here
34
      "201":
34
      "201":
35
        description: Created claim
35
        description: Created claim
36
        schema:
36
        schema:
37
          $ref: ../definitions.yaml#/return_claim
37
          $ref: "../swagger.yaml#/definitions/return_claim"
38
      "400":
38
      "400":
39
        description: Bad request
39
        description: Bad request
40
        schema:
40
        schema:
41
          $ref: ../definitions.yaml#/error
41
          $ref: "../swagger.yaml#/definitions/error"
42
      "401":
42
      "401":
43
        description: Authentication required
43
        description: Authentication required
44
        schema:
44
        schema:
45
          $ref: ../definitions.yaml#/error
45
          $ref: "../swagger.yaml#/definitions/error"
46
      "403":
46
      "403":
47
        description: Access forbidden
47
        description: Access forbidden
48
        schema:
48
        schema:
49
          $ref: ../definitions.yaml#/error
49
          $ref: "../swagger.yaml#/definitions/error"
50
      "404":
50
      "404":
51
        description: Checkout not found
51
        description: Checkout not found
52
        schema:
52
        schema:
53
          $ref: ../definitions.yaml#/error
53
          $ref: "../swagger.yaml#/definitions/error"
54
      "409":
54
      "409":
55
        description: Conflict creating the resource
55
        description: Conflict creating the resource
56
        schema:
56
        schema:
57
          $ref: ../definitions.yaml#/error
57
          $ref: "../swagger.yaml#/definitions/error"
58
      "500":
58
      "500":
59
        description: |
59
        description: |
60
          Internal server error. Possible `error_code` attribute values:
60
          Internal server error. Possible `error_code` attribute values:
61
61
62
          * `internal_server_error`
62
          * `internal_server_error`
63
        schema:
63
        schema:
64
          $ref: ../definitions.yaml#/error
64
          $ref: "../swagger.yaml#/definitions/error"
65
      "503":
65
      "503":
66
        description: Under maintenance
66
        description: Under maintenance
67
        schema:
67
        schema:
68
          $ref: ../definitions.yaml#/error
68
          $ref: "../swagger.yaml#/definitions/error"
69
    x-koha-authorization:
69
    x-koha-authorization:
70
      permissions:
70
      permissions:
71
        circulate: circulate_remaining_permissions
71
        circulate: circulate_remaining_permissions
Lines 102-135 Link Here
102
      "200":
102
      "200":
103
        description: Claim notes updated
103
        description: Claim notes updated
104
        schema:
104
        schema:
105
          $ref: ../definitions.yaml#/return_claim
105
          $ref: "../swagger.yaml#/definitions/return_claim"
106
      "400":
106
      "400":
107
        description: Bad request
107
        description: Bad request
108
        schema:
108
        schema:
109
          $ref: ../definitions.yaml#/error
109
          $ref: "../swagger.yaml#/definitions/error"
110
      "401":
110
      "401":
111
        description: Authentication required
111
        description: Authentication required
112
        schema:
112
        schema:
113
          $ref: ../definitions.yaml#/error
113
          $ref: "../swagger.yaml#/definitions/error"
114
      "403":
114
      "403":
115
        description: Access forbidden
115
        description: Access forbidden
116
        schema:
116
        schema:
117
          $ref: ../definitions.yaml#/error
117
          $ref: "../swagger.yaml#/definitions/error"
118
      "404":
118
      "404":
119
        description: Claim not found
119
        description: Claim not found
120
        schema:
120
        schema:
121
          $ref: ../definitions.yaml#/error
121
          $ref: "../swagger.yaml#/definitions/error"
122
      "500":
122
      "500":
123
        description: |
123
        description: |
124
          Internal server error. Possible `error_code` attribute values:
124
          Internal server error. Possible `error_code` attribute values:
125
125
126
          * `internal_server_error`
126
          * `internal_server_error`
127
        schema:
127
        schema:
128
          $ref: ../definitions.yaml#/error
128
          $ref: "../swagger.yaml#/definitions/error"
129
      "503":
129
      "503":
130
        description: Under maintenance
130
        description: Under maintenance
131
        schema:
131
        schema:
132
          $ref: ../definitions.yaml#/error
132
          $ref: "../swagger.yaml#/definitions/error"
133
    x-koha-authorization:
133
    x-koha-authorization:
134
      permissions:
134
      permissions:
135
        circulate: circulate_remaining_permissions
135
        circulate: circulate_remaining_permissions
Lines 152-185 Link Here
152
      "204":
152
      "204":
153
        description: Claim deleted
153
        description: Claim deleted
154
        schema:
154
        schema:
155
          $ref: ../definitions.yaml#/return_claim
155
          $ref: "../swagger.yaml#/definitions/return_claim"
156
      "400":
156
      "400":
157
        description: Bad request
157
        description: Bad request
158
        schema:
158
        schema:
159
          $ref: ../definitions.yaml#/error
159
          $ref: "../swagger.yaml#/definitions/error"
160
      "401":
160
      "401":
161
        description: Authentication required
161
        description: Authentication required
162
        schema:
162
        schema:
163
          $ref: ../definitions.yaml#/error
163
          $ref: "../swagger.yaml#/definitions/error"
164
      "403":
164
      "403":
165
        description: Access forbidden
165
        description: Access forbidden
166
        schema:
166
        schema:
167
          $ref: ../definitions.yaml#/error
167
          $ref: "../swagger.yaml#/definitions/error"
168
      "404":
168
      "404":
169
        description: Claim not found
169
        description: Claim not found
170
        schema:
170
        schema:
171
          $ref: ../definitions.yaml#/error
171
          $ref: "../swagger.yaml#/definitions/error"
172
      "500":
172
      "500":
173
        description: |
173
        description: |
174
          Internal server error. Possible `error_code` attribute values:
174
          Internal server error. Possible `error_code` attribute values:
175
175
176
          * `internal_server_error`
176
          * `internal_server_error`
177
        schema:
177
        schema:
178
          $ref: ../definitions.yaml#/error
178
          $ref: "../swagger.yaml#/definitions/error"
179
      "503":
179
      "503":
180
        description: Under maintenance
180
        description: Under maintenance
181
        schema:
181
        schema:
182
          $ref: ../definitions.yaml#/error
182
          $ref: "../swagger.yaml#/definitions/error"
183
    x-koha-authorization:
183
    x-koha-authorization:
184
      permissions:
184
      permissions:
185
        circulate: circulate_remaining_permissions
185
        circulate: circulate_remaining_permissions
Lines 219-252 Link Here
219
      "200":
219
      "200":
220
        description: Claim resolved
220
        description: Claim resolved
221
        schema:
221
        schema:
222
          $ref: ../definitions.yaml#/return_claim
222
          $ref: "../swagger.yaml#/definitions/return_claim"
223
      "400":
223
      "400":
224
        description: Bad request
224
        description: Bad request
225
        schema:
225
        schema:
226
          $ref: ../definitions.yaml#/error
226
          $ref: "../swagger.yaml#/definitions/error"
227
      "401":
227
      "401":
228
        description: Authentication required
228
        description: Authentication required
229
        schema:
229
        schema:
230
          $ref: ../definitions.yaml#/error
230
          $ref: "../swagger.yaml#/definitions/error"
231
      "403":
231
      "403":
232
        description: Access forbidden
232
        description: Access forbidden
233
        schema:
233
        schema:
234
          $ref: ../definitions.yaml#/error
234
          $ref: "../swagger.yaml#/definitions/error"
235
      "404":
235
      "404":
236
        description: Claim not found
236
        description: Claim not found
237
        schema:
237
        schema:
238
          $ref: ../definitions.yaml#/error
238
          $ref: "../swagger.yaml#/definitions/error"
239
      "500":
239
      "500":
240
        description: |
240
        description: |
241
          Internal server error. Possible `error_code` attribute values:
241
          Internal server error. Possible `error_code` attribute values:
242
242
243
          * `internal_server_error`
243
          * `internal_server_error`
244
        schema:
244
        schema:
245
          $ref: ../definitions.yaml#/error
245
          $ref: "../swagger.yaml#/definitions/error"
246
      "503":
246
      "503":
247
        description: Under maintenance
247
        description: Under maintenance
248
        schema:
248
        schema:
249
          $ref: ../definitions.yaml#/error
249
          $ref: "../swagger.yaml#/definitions/error"
250
    x-koha-authorization:
250
    x-koha-authorization:
251
      permissions:
251
      permissions:
252
        circulate: circulate_remaining_permissions
252
        circulate: circulate_remaining_permissions
(-)a/api/v1/swagger/paths/rotas.yaml (-6 / +6 lines)
Lines 31-60 Link Here
31
      "400":
31
      "400":
32
        description: Bad request
32
        description: Bad request
33
        schema:
33
        schema:
34
          $ref: ../definitions.yaml#/error
34
          $ref: "../swagger.yaml#/definitions/error"
35
      "401":
35
      "401":
36
        description: Authentication required
36
        description: Authentication required
37
        schema:
37
        schema:
38
          $ref: ../definitions.yaml#/error
38
          $ref: "../swagger.yaml#/definitions/error"
39
      "403":
39
      "403":
40
        description: Access forbidden
40
        description: Access forbidden
41
        schema:
41
        schema:
42
          $ref: ../definitions.yaml#/error
42
          $ref: "../swagger.yaml#/definitions/error"
43
      "404":
43
      "404":
44
        description: Position not found
44
        description: Position not found
45
        schema:
45
        schema:
46
          $ref: ../definitions.yaml#/error
46
          $ref: "../swagger.yaml#/definitions/error"
47
      "500":
47
      "500":
48
        description: |
48
        description: |
49
          Internal server error. Possible `error_code` attribute values:
49
          Internal server error. Possible `error_code` attribute values:
50
50
51
          * `internal_server_error`
51
          * `internal_server_error`
52
        schema:
52
        schema:
53
          $ref: ../definitions.yaml#/error
53
          $ref: "../swagger.yaml#/definitions/error"
54
      "503":
54
      "503":
55
        description: Under maintenance
55
        description: Under maintenance
56
        schema:
56
        schema:
57
          $ref: ../definitions.yaml#/error
57
          $ref: "../swagger.yaml#/definitions/error"
58
    x-koha-authorization:
58
    x-koha-authorization:
59
      permissions:
59
      permissions:
60
        stockrotation: "1"
60
        stockrotation: "1"
(-)a/api/v1/swagger/paths/suggestions.yaml (-37 / +37 lines)
Lines 8-20 Link Here
8
    tags:
8
    tags:
9
      - suggestions
9
      - suggestions
10
    parameters:
10
    parameters:
11
      - $ref: ../parameters.yaml#/match
11
      - $ref: "../swagger.yaml#/parameters/match"
12
      - $ref: ../parameters.yaml#/order_by
12
      - $ref: "../swagger.yaml#/parameters/order_by"
13
      - $ref: ../parameters.yaml#/page
13
      - $ref: "../swagger.yaml#/parameters/page"
14
      - $ref: ../parameters.yaml#/per_page
14
      - $ref: "../swagger.yaml#/parameters/per_page"
15
      - $ref: ../parameters.yaml#/q_param
15
      - $ref: "../swagger.yaml#/parameters/q_param"
16
      - $ref: ../parameters.yaml#/q_body
16
      - $ref: "../swagger.yaml#/parameters/q_body"
17
      - $ref: ../parameters.yaml#/q_header
17
      - $ref: "../swagger.yaml#/parameters/q_header"
18
    produces:
18
    produces:
19
      - application/json
19
      - application/json
20
    responses:
20
    responses:
Lines 23-44 Link Here
23
        schema:
23
        schema:
24
          type: array
24
          type: array
25
          items:
25
          items:
26
            $ref: ../definitions.yaml#/suggestion
26
            $ref: "../swagger.yaml#/definitions/suggestion"
27
      "403":
27
      "403":
28
        description: Access forbidden
28
        description: Access forbidden
29
        schema:
29
        schema:
30
          $ref: ../definitions.yaml#/error
30
          $ref: "../swagger.yaml#/definitions/error"
31
      "500":
31
      "500":
32
        description: |
32
        description: |
33
          Internal server error. Possible `error_code` attribute values:
33
          Internal server error. Possible `error_code` attribute values:
34
34
35
          * `internal_server_error`
35
          * `internal_server_error`
36
        schema:
36
        schema:
37
          $ref: ../definitions.yaml#/error
37
          $ref: "../swagger.yaml#/definitions/error"
38
      "503":
38
      "503":
39
        description: Under maintenance
39
        description: Under maintenance
40
        schema:
40
        schema:
41
          $ref: ../definitions.yaml#/error
41
          $ref: "../swagger.yaml#/definitions/error"
42
    x-koha-authorization:
42
    x-koha-authorization:
43
      permissions:
43
      permissions:
44
        suggestions: suggestions_manage
44
        suggestions: suggestions_manage
Lines 55-87 Link Here
55
        description: A JSON object containing informations about the new suggestion
55
        description: A JSON object containing informations about the new suggestion
56
        required: true
56
        required: true
57
        schema:
57
        schema:
58
          $ref: ../definitions.yaml#/suggestion
58
          $ref: "../swagger.yaml#/definitions/suggestion"
59
    produces:
59
    produces:
60
      - application/json
60
      - application/json
61
    responses:
61
    responses:
62
      "201":
62
      "201":
63
        description: Suggestion added
63
        description: Suggestion added
64
        schema:
64
        schema:
65
          $ref: ../definitions.yaml#/suggestion
65
          $ref: "../swagger.yaml#/definitions/suggestion"
66
      "400":
66
      "400":
67
        description: Bad request
67
        description: Bad request
68
        schema:
68
        schema:
69
          $ref: ../definitions.yaml#/error
69
          $ref: "../swagger.yaml#/definitions/error"
70
      "403":
70
      "403":
71
        description: Access forbidden
71
        description: Access forbidden
72
        schema:
72
        schema:
73
          $ref: ../definitions.yaml#/error
73
          $ref: "../swagger.yaml#/definitions/error"
74
      "500":
74
      "500":
75
        description: |
75
        description: |
76
          Internal server error. Possible `error_code` attribute values:
76
          Internal server error. Possible `error_code` attribute values:
77
77
78
          * `internal_server_error`
78
          * `internal_server_error`
79
        schema:
79
        schema:
80
          $ref: ../definitions.yaml#/error
80
          $ref: "../swagger.yaml#/definitions/error"
81
      "503":
81
      "503":
82
        description: Under maintenance
82
        description: Under maintenance
83
        schema:
83
        schema:
84
          $ref: ../definitions.yaml#/error
84
          $ref: "../swagger.yaml#/definitions/error"
85
    x-koha-authorization:
85
    x-koha-authorization:
86
      permissions:
86
      permissions:
87
        suggestions: suggestions_manage
87
        suggestions: suggestions_manage
Lines 94-126 Link Here
94
    tags:
94
    tags:
95
      - suggestions
95
      - suggestions
96
    parameters:
96
    parameters:
97
      - $ref: ../parameters.yaml#/suggestion_id_pp
97
      - $ref: "../swagger.yaml#/parameters/suggestion_id_pp"
98
    produces:
98
    produces:
99
      - application/json
99
      - application/json
100
    responses:
100
    responses:
101
      "200":
101
      "200":
102
        description: A suggestion
102
        description: A suggestion
103
        schema:
103
        schema:
104
          $ref: ../definitions.yaml#/suggestion
104
          $ref: "../swagger.yaml#/definitions/suggestion"
105
      "403":
105
      "403":
106
        description: Access forbidden
106
        description: Access forbidden
107
        schema:
107
        schema:
108
          $ref: ../definitions.yaml#/error
108
          $ref: "../swagger.yaml#/definitions/error"
109
      "404":
109
      "404":
110
        description: Suggestion not found
110
        description: Suggestion not found
111
        schema:
111
        schema:
112
          $ref: ../definitions.yaml#/error
112
          $ref: "../swagger.yaml#/definitions/error"
113
      "500":
113
      "500":
114
        description: |
114
        description: |
115
          Internal server error. Possible `error_code` attribute values:
115
          Internal server error. Possible `error_code` attribute values:
116
116
117
          * `internal_server_error`
117
          * `internal_server_error`
118
        schema:
118
        schema:
119
          $ref: ../definitions.yaml#/error
119
          $ref: "../swagger.yaml#/definitions/error"
120
      "503":
120
      "503":
121
        description: Under maintenance
121
        description: Under maintenance
122
        schema:
122
        schema:
123
          $ref: ../definitions.yaml#/error
123
          $ref: "../swagger.yaml#/definitions/error"
124
    x-koha-authorization:
124
    x-koha-authorization:
125
      permissions:
125
      permissions:
126
        suggestions: suggestions_manage
126
        suggestions: suggestions_manage
Lines 132-174 Link Here
132
    tags:
132
    tags:
133
      - suggestions
133
      - suggestions
134
    parameters:
134
    parameters:
135
      - $ref: ../parameters.yaml#/suggestion_id_pp
135
      - $ref: "../swagger.yaml#/parameters/suggestion_id_pp"
136
      - name: body
136
      - name: body
137
        in: body
137
        in: body
138
        description: A JSON object containing informations about the new hold
138
        description: A JSON object containing informations about the new hold
139
        required: true
139
        required: true
140
        schema:
140
        schema:
141
          $ref: ../definitions.yaml#/suggestion
141
          $ref: "../swagger.yaml#/definitions/suggestion"
142
    produces:
142
    produces:
143
      - application/json
143
      - application/json
144
    responses:
144
    responses:
145
      "200":
145
      "200":
146
        description: A suggestion
146
        description: A suggestion
147
        schema:
147
        schema:
148
          $ref: ../definitions.yaml#/suggestion
148
          $ref: "../swagger.yaml#/definitions/suggestion"
149
      "400":
149
      "400":
150
        description: Bad request
150
        description: Bad request
151
        schema:
151
        schema:
152
          $ref: ../definitions.yaml#/error
152
          $ref: "../swagger.yaml#/definitions/error"
153
      "403":
153
      "403":
154
        description: Access forbidden
154
        description: Access forbidden
155
        schema:
155
        schema:
156
          $ref: ../definitions.yaml#/error
156
          $ref: "../swagger.yaml#/definitions/error"
157
      "404":
157
      "404":
158
        description: Suggestion not found
158
        description: Suggestion not found
159
        schema:
159
        schema:
160
          $ref: ../definitions.yaml#/error
160
          $ref: "../swagger.yaml#/definitions/error"
161
      "500":
161
      "500":
162
        description: |
162
        description: |
163
          Internal server error. Possible `error_code` attribute values:
163
          Internal server error. Possible `error_code` attribute values:
164
164
165
          * `internal_server_error`
165
          * `internal_server_error`
166
        schema:
166
        schema:
167
          $ref: ../definitions.yaml#/error
167
          $ref: "../swagger.yaml#/definitions/error"
168
      "503":
168
      "503":
169
        description: Under maintenance
169
        description: Under maintenance
170
        schema:
170
        schema:
171
          $ref: ../definitions.yaml#/error
171
          $ref: "../swagger.yaml#/definitions/error"
172
    x-koha-authorization:
172
    x-koha-authorization:
173
      permissions:
173
      permissions:
174
        suggestions: suggestions_manage
174
        suggestions: suggestions_manage
Lines 180-186 Link Here
180
    tags:
180
    tags:
181
      - suggestions
181
      - suggestions
182
    parameters:
182
    parameters:
183
      - $ref: ../parameters.yaml#/suggestion_id_pp
183
      - $ref: "../swagger.yaml#/parameters/suggestion_id_pp"
184
    produces:
184
    produces:
185
      - application/json
185
      - application/json
186
    responses:
186
    responses:
Lines 191-216 Link Here
191
      "401":
191
      "401":
192
        description: Authentication required
192
        description: Authentication required
193
        schema:
193
        schema:
194
          $ref: ../definitions.yaml#/error
194
          $ref: "../swagger.yaml#/definitions/error"
195
      "403":
195
      "403":
196
        description: Access forbidden
196
        description: Access forbidden
197
        schema:
197
        schema:
198
          $ref: ../definitions.yaml#/error
198
          $ref: "../swagger.yaml#/definitions/error"
199
      "404":
199
      "404":
200
        description: Suggestion not found
200
        description: Suggestion not found
201
        schema:
201
        schema:
202
          $ref: ../definitions.yaml#/error
202
          $ref: "../swagger.yaml#/definitions/error"
203
      "500":
203
      "500":
204
        description: |
204
        description: |
205
          Internal server error. Possible `error_code` attribute values:
205
          Internal server error. Possible `error_code` attribute values:
206
206
207
          * `internal_server_error`
207
          * `internal_server_error`
208
        schema:
208
        schema:
209
          $ref: ../definitions.yaml#/error
209
          $ref: "../swagger.yaml#/definitions/error"
210
      "503":
210
      "503":
211
        description: Under maintenance
211
        description: Under maintenance
212
        schema:
212
        schema:
213
          $ref: ../definitions.yaml#/error
213
          $ref: "../swagger.yaml#/definitions/error"
214
    x-koha-authorization:
214
    x-koha-authorization:
215
      permissions:
215
      permissions:
216
        suggestions: suggestions_manage
216
        suggestions: suggestions_manage
(-)a/api/v1/swagger/paths/transfer_limits.yaml (-32 / +32 lines)
Lines 27-39 Link Here
27
        description: Search on collection_code
27
        description: Search on collection_code
28
        required: false
28
        required: false
29
        type: string
29
        type: string
30
      - $ref: ../parameters.yaml#/match
30
      - $ref: "../swagger.yaml#/parameters/match"
31
      - $ref: ../parameters.yaml#/order_by
31
      - $ref: "../swagger.yaml#/parameters/order_by"
32
      - $ref: ../parameters.yaml#/page
32
      - $ref: "../swagger.yaml#/parameters/page"
33
      - $ref: ../parameters.yaml#/per_page
33
      - $ref: "../swagger.yaml#/parameters/per_page"
34
      - $ref: ../parameters.yaml#/q_param
34
      - $ref: "../swagger.yaml#/parameters/q_param"
35
      - $ref: ../parameters.yaml#/q_body
35
      - $ref: "../swagger.yaml#/parameters/q_body"
36
      - $ref: ../parameters.yaml#/q_header
36
      - $ref: "../swagger.yaml#/parameters/q_header"
37
    produces:
37
    produces:
38
      - application/json
38
      - application/json
39
    responses:
39
    responses:
Lines 42-59 Link Here
42
        schema:
42
        schema:
43
          type: array
43
          type: array
44
          items:
44
          items:
45
            $ref: ../definitions.yaml#/transfer_limit
45
            $ref: "../swagger.yaml#/definitions/transfer_limit"
46
      "500":
46
      "500":
47
        description: |
47
        description: |
48
          Internal server error. Possible `error_code` attribute values:
48
          Internal server error. Possible `error_code` attribute values:
49
49
50
          * `internal_server_error`
50
          * `internal_server_error`
51
        schema:
51
        schema:
52
          $ref: ../definitions.yaml#/error
52
          $ref: "../swagger.yaml#/definitions/error"
53
      "503":
53
      "503":
54
        description: Under maintenance
54
        description: Under maintenance
55
        schema:
55
        schema:
56
          $ref: ../definitions.yaml#/error
56
          $ref: "../swagger.yaml#/definitions/error"
57
    x-koha-authorization:
57
    x-koha-authorization:
58
      permissions:
58
      permissions:
59
        parameters: manage_transfers
59
        parameters: manage_transfers
Lines 71-111 Link Here
71
        description: A JSON object containing information about a new transfer limit
71
        description: A JSON object containing information about a new transfer limit
72
        required: true
72
        required: true
73
        schema:
73
        schema:
74
          $ref: ../definitions.yaml#/transfer_limit
74
          $ref: "../swagger.yaml#/definitions/transfer_limit"
75
    produces:
75
    produces:
76
      - application/json
76
      - application/json
77
    responses:
77
    responses:
78
      "201":
78
      "201":
79
        description: Transfer limit added
79
        description: Transfer limit added
80
        schema:
80
        schema:
81
          $ref: ../definitions.yaml#/transfer_limit
81
          $ref: "../swagger.yaml#/definitions/transfer_limit"
82
      "400":
82
      "400":
83
        description: Bad request
83
        description: Bad request
84
        schema:
84
        schema:
85
          $ref: ../definitions.yaml#/error
85
          $ref: "../swagger.yaml#/definitions/error"
86
      "401":
86
      "401":
87
        description: Authentication required
87
        description: Authentication required
88
        schema:
88
        schema:
89
          $ref: ../definitions.yaml#/error
89
          $ref: "../swagger.yaml#/definitions/error"
90
      "403":
90
      "403":
91
        description: Access forbidden
91
        description: Access forbidden
92
        schema:
92
        schema:
93
          $ref: ../definitions.yaml#/error
93
          $ref: "../swagger.yaml#/definitions/error"
94
      "409":
94
      "409":
95
        description: Conflict in creating resource
95
        description: Conflict in creating resource
96
        schema:
96
        schema:
97
          $ref: ../definitions.yaml#/error
97
          $ref: "../swagger.yaml#/definitions/error"
98
      "500":
98
      "500":
99
        description: |
99
        description: |
100
          Internal server error. Possible `error_code` attribute values:
100
          Internal server error. Possible `error_code` attribute values:
101
101
102
          * `internal_server_error`
102
          * `internal_server_error`
103
        schema:
103
        schema:
104
          $ref: ../definitions.yaml#/error
104
          $ref: "../swagger.yaml#/definitions/error"
105
      "503":
105
      "503":
106
        description: Under maintenance
106
        description: Under maintenance
107
        schema:
107
        schema:
108
          $ref: ../definitions.yaml#/error
108
          $ref: "../swagger.yaml#/definitions/error"
109
    x-koha-authorization:
109
    x-koha-authorization:
110
      permissions:
110
      permissions:
111
        parameters: manage_transfers
111
        parameters: manage_transfers
Lines 118-124 Link Here
118
      - transfer
118
      - transfer
119
    summary: Delete transfer limit
119
    summary: Delete transfer limit
120
    parameters:
120
    parameters:
121
      - $ref: ../parameters.yaml#/transfer_limit_id_pp
121
      - $ref: "../swagger.yaml#/parameters/transfer_limit_id_pp"
122
    produces:
122
    produces:
123
      - application/json
123
      - application/json
124
    responses:
124
    responses:
Lines 129-154 Link Here
129
      "401":
129
      "401":
130
        description: Authentication required
130
        description: Authentication required
131
        schema:
131
        schema:
132
          $ref: ../definitions.yaml#/error
132
          $ref: "../swagger.yaml#/definitions/error"
133
      "403":
133
      "403":
134
        description: Access forbidden
134
        description: Access forbidden
135
        schema:
135
        schema:
136
          $ref: ../definitions.yaml#/error
136
          $ref: "../swagger.yaml#/definitions/error"
137
      "404":
137
      "404":
138
        description: Library not found
138
        description: Library not found
139
        schema:
139
        schema:
140
          $ref: ../definitions.yaml#/error
140
          $ref: "../swagger.yaml#/definitions/error"
141
      "500":
141
      "500":
142
        description: |
142
        description: |
143
          Internal server error. Possible `error_code` attribute values:
143
          Internal server error. Possible `error_code` attribute values:
144
144
145
          * `internal_server_error`
145
          * `internal_server_error`
146
        schema:
146
        schema:
147
          $ref: ../definitions.yaml#/error
147
          $ref: "../swagger.yaml#/definitions/error"
148
      "503":
148
      "503":
149
        description: Under maintenance
149
        description: Under maintenance
150
        schema:
150
        schema:
151
          $ref: ../definitions.yaml#/error
151
          $ref: "../swagger.yaml#/definitions/error"
152
    x-koha-authorization:
152
    x-koha-authorization:
153
      permissions:
153
      permissions:
154
        parameters: manage_transfers
154
        parameters: manage_transfers
Lines 230-247 Link Here
230
        schema:
230
        schema:
231
          type: array
231
          type: array
232
          items:
232
          items:
233
            $ref: ../definitions.yaml#/transfer_limit
233
            $ref: "../swagger.yaml#/definitions/transfer_limit"
234
      "500":
234
      "500":
235
        description: |
235
        description: |
236
          Internal server error. Possible `error_code` attribute values:
236
          Internal server error. Possible `error_code` attribute values:
237
237
238
          * `internal_server_error`
238
          * `internal_server_error`
239
        schema:
239
        schema:
240
          $ref: ../definitions.yaml#/error
240
          $ref: "../swagger.yaml#/definitions/error"
241
      "503":
241
      "503":
242
        description: Under maintenance
242
        description: Under maintenance
243
        schema:
243
        schema:
244
          $ref: ../definitions.yaml#/error
244
          $ref: "../swagger.yaml#/definitions/error"
245
    x-koha-authorization:
245
    x-koha-authorization:
246
      permissions:
246
      permissions:
247
        parameters: manage_transfers
247
        parameters: manage_transfers
Lines 290-315 Link Here
290
      "401":
290
      "401":
291
        description: Authentication required
291
        description: Authentication required
292
        schema:
292
        schema:
293
          $ref: ../definitions.yaml#/error
293
          $ref: "../swagger.yaml#/definitions/error"
294
      "403":
294
      "403":
295
        description: Access forbidden
295
        description: Access forbidden
296
        schema:
296
        schema:
297
          $ref: ../definitions.yaml#/error
297
          $ref: "../swagger.yaml#/definitions/error"
298
      "404":
298
      "404":
299
        description: Library not found
299
        description: Library not found
300
        schema:
300
        schema:
301
          $ref: ../definitions.yaml#/error
301
          $ref: "../swagger.yaml#/definitions/error"
302
      "500":
302
      "500":
303
        description: |
303
        description: |
304
          Internal server error. Possible `error_code` attribute values:
304
          Internal server error. Possible `error_code` attribute values:
305
305
306
          * `internal_server_error`
306
          * `internal_server_error`
307
        schema:
307
        schema:
308
          $ref: ../definitions.yaml#/error
308
          $ref: "../swagger.yaml#/definitions/error"
309
      "503":
309
      "503":
310
        description: Under maintenance
310
        description: Under maintenance
311
        schema:
311
        schema:
312
          $ref: ../definitions.yaml#/error
312
          $ref: "../swagger.yaml#/definitions/error"
313
    x-koha-authorization:
313
    x-koha-authorization:
314
      permissions:
314
      permissions:
315
        parameters: manage_transfers
315
        parameters: manage_transfers
(-)a/api/v1/swagger/swagger.yaml (-128 / +308 lines)
Lines 3-212 swagger: 2.0 Link Here
3
basePath: /api/v1
3
basePath: /api/v1
4
definitions:
4
definitions:
5
  account_line:
5
  account_line:
6
    $ref: definitions/account_line.yaml
6
    $ref: ./definitions/account_line.yaml
7
  advancededitormacro:
7
  advancededitormacro:
8
    $ref: definitions/advancededitormacro.yaml
8
    $ref: ./definitions/advancededitormacro.yaml
9
  allows_renewal:
9
  allows_renewal:
10
    $ref: definitions/allows_renewal.yaml
10
    $ref: ./definitions/allows_renewal.yaml
11
  basket:
11
  basket:
12
    $ref: definitions/basket.yaml
12
    $ref: ./definitions/basket.yaml
13
  cashup:
13
  cashup:
14
    $ref: definitions/cashup.yaml
14
    $ref: ./definitions/cashup.yaml
15
  checkout:
15
  checkout:
16
    $ref: definitions/checkout.yaml
16
    $ref: ./definitions/checkout.yaml
17
  checkouts:
17
  checkouts:
18
    $ref: definitions/checkouts.yaml
18
    $ref: ./definitions/checkouts.yaml
19
  circ-rule-kind:
19
  circ-rule-kind:
20
    $ref: definitions/circ-rule-kind.yaml
20
    $ref: ./definitions/circ-rule-kind.yaml
21
  city:
21
  city:
22
    $ref: definitions/city.yaml
22
    $ref: ./definitions/city.yaml
23
  error:
23
  error:
24
    $ref: definitions/error.yaml
24
    $ref: ./definitions/error.yaml
25
  fund:
25
  fund:
26
    $ref: definitions/fund.yaml
26
    $ref: ./definitions/fund.yaml
27
  hold:
27
  hold:
28
    $ref: definitions/hold.yaml
28
    $ref: ./definitions/hold.yaml
29
  holds:
29
  holds:
30
    $ref: definitions/holds.yaml
30
    $ref: ./definitions/holds.yaml
31
  ill_backend:
31
  ill_backend:
32
    $ref: definitions/ill_backend.yaml
32
    $ref: ./definitions/ill_backend.yaml
33
  ill_backends:
33
  ill_backends:
34
    $ref: definitions/ill_backends.yaml
34
    $ref: ./definitions/ill_backends.yaml
35
  import_batch_profile:
35
  import_batch_profile:
36
    $ref: definitions/import_batch_profile.yaml
36
    $ref: ./definitions/import_batch_profile.yaml
37
  import_batch_profiles:
37
  import_batch_profiles:
38
    $ref: definitions/import_batch_profiles.yaml
38
    $ref: ./definitions/import_batch_profiles.yaml
39
  invoice:
39
  invoice:
40
    $ref: definitions/invoice.yaml
40
    $ref: ./definitions/invoice.yaml
41
  item:
41
  item:
42
    $ref: definitions/item.yaml
42
    $ref: ./definitions/item.yaml
43
  library:
43
  library:
44
    $ref: definitions/library.yaml
44
    $ref: ./definitions/library.yaml
45
  order:
45
  order:
46
    $ref: definitions/order.yaml
46
    $ref: ./definitions/order.yaml
47
  patron:
47
  patron:
48
    $ref: definitions/patron.yaml
48
    $ref: ./definitions/patron.yaml
49
  patron_account_credit:
49
  patron_account_credit:
50
    $ref: definitions/patron_account_credit.yaml
50
    $ref: ./definitions/patron_account_credit.yaml
51
  patron_balance:
51
  patron_balance:
52
    $ref: definitions/patron_balance.yaml
52
    $ref: ./definitions/patron_balance.yaml
53
  patron_extended_attribute:
53
  patron_extended_attribute:
54
    $ref: definitions/patron_extended_attribute.yaml
54
    $ref: ./definitions/patron_extended_attribute.yaml
55
  quote:
55
  quote:
56
    $ref: definitions/quote.yaml
56
    $ref: ./definitions/quote.yaml
57
  return_claim:
57
  return_claim:
58
    $ref: definitions/return_claim.yaml
58
    $ref: ./definitions/return_claim.yaml
59
  smtp_server:
59
  smtp_server:
60
    $ref: definitions/smtp_server.yaml
60
    $ref: ./definitions/smtp_server.yaml
61
  suggestion:
61
  suggestion:
62
    $ref: definitions/suggestion.yaml
62
    $ref: ./definitions/suggestion.yaml
63
  transfer_limit:
63
  transfer_limit:
64
    $ref: definitions/transfer_limit.yaml
64
    $ref: ./definitions/transfer_limit.yaml
65
  vendor:
65
  vendor:
66
    $ref: definitions/vendor.yaml
66
    $ref: ./definitions/vendor.yaml
67
paths:
67
paths:
68
  /acquisitions/funds:
68
  /acquisitions/funds:
69
    $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds
69
    $ref: ./paths/acquisitions_funds.yaml#/~1acquisitions~1funds
70
  /acquisitions/orders:
70
  /acquisitions/orders:
71
    $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders
71
    $ref: ./paths/acquisitions_orders.yaml#/~1acquisitions~1orders
72
  "/acquisitions/orders/{order_id}":
72
  "/acquisitions/orders/{order_id}":
73
    $ref: "paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}"
73
    $ref: "./paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}"
74
  /acquisitions/vendors:
74
  /acquisitions/vendors:
75
    $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
75
    $ref: ./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors
76
  "/acquisitions/vendors/{vendor_id}":
76
  "/acquisitions/vendors/{vendor_id}":
77
    $ref: "paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}"
77
    $ref: "./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}"
78
  /advanced_editor/macros:
78
  /advanced_editor/macros:
79
    $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros
79
    $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros
80
  /advanced_editor/macros/shared:
80
  /advanced_editor/macros/shared:
81
    $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared
81
    $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared
82
  "/advanced_editor/macros/shared/{advancededitormacro_id}":
82
  "/advanced_editor/macros/shared/{advancededitormacro_id}":
83
    $ref: "paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}"
83
    $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}"
84
  "/advanced_editor/macros/{advancededitormacro_id}":
84
  "/advanced_editor/macros/{advancededitormacro_id}":
85
    $ref: "paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}"
85
    $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}"
86
  "/article_requests/{article_request_id}":
86
  "/article_requests/{article_request_id}":
87
    $ref: "paths/article_requests.yaml#/~1article_requests~1{article_request_id}"
87
    $ref: "./paths/article_requests.yaml#/~1article_requests~1{article_request_id}"
88
  "/biblios/{biblio_id}":
88
  "/biblios/{biblio_id}":
89
    $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}"
89
    $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}"
90
  "/biblios/{biblio_id}/checkouts":
90
  "/biblios/{biblio_id}/checkouts":
91
    $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts"
91
    $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts"
92
  "/biblios/{biblio_id}/items":
92
  "/biblios/{biblio_id}/items":
93
    $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1items"
93
    $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1items"
94
  "/biblios/{biblio_id}/pickup_locations":
94
  "/biblios/{biblio_id}/pickup_locations":
95
    $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations"
95
    $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations"
96
  "/cash_registers/{cash_register_id}/cashups":
96
  "/cash_registers/{cash_register_id}/cashups":
97
    $ref: "paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups"
97
    $ref: "./paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups"
98
  "/cashups/{cashup_id}":
98
  "/cashups/{cashup_id}":
99
    $ref: "paths/cash_registers.yaml#/~1cashups~1{cashup_id}"
99
    $ref: "./paths/cash_registers.yaml#/~1cashups~1{cashup_id}"
100
  /checkouts:
100
  /checkouts:
101
    $ref: paths/checkouts.yaml#/~1checkouts
101
    $ref: ./paths/checkouts.yaml#/~1checkouts
102
  "/checkouts/{checkout_id}":
102
  "/checkouts/{checkout_id}":
103
    $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
103
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}"
104
  "/checkouts/{checkout_id}/allows_renewal":
104
  "/checkouts/{checkout_id}/allows_renewal":
105
    $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
105
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal"
106
  "/checkouts/{checkout_id}/renewal":
106
  "/checkouts/{checkout_id}/renewal":
107
    $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
107
    $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal"
108
  /circulation-rules/kinds:
108
  /circulation-rules/kinds:
109
    $ref: paths/circulation-rules.yaml#/~1circulation-rules~1kinds
109
    $ref: ./paths/circulation-rules.yaml#/~1circulation-rules~1kinds
110
  /cities:
110
  /cities:
111
    $ref: paths/cities.yaml#/~1cities
111
    $ref: ./paths/cities.yaml#/~1cities
112
  "/cities/{city_id}":
112
  "/cities/{city_id}":
113
    $ref: "paths/cities.yaml#/~1cities~1{city_id}"
113
    $ref: "./paths/cities.yaml#/~1cities~1{city_id}"
114
  "/clubs/{club_id}/holds":
114
  "/clubs/{club_id}/holds":
115
    $ref: "paths/clubs.yaml#/~1clubs~1{club_id}~1holds"
115
    $ref: "./paths/clubs.yaml#/~1clubs~1{club_id}~1holds"
116
  /config/smtp_servers:
116
  /config/smtp_servers:
117
    $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers
117
    $ref: ./paths/config_smtp_servers.yaml#/~1config~1smtp_servers
118
  "/config/smtp_servers/{smtp_server_id}":
118
  "/config/smtp_servers/{smtp_server_id}":
119
    $ref: "paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}"
119
    $ref: "./paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}"
120
  /holds:
120
  /holds:
121
    $ref: paths/holds.yaml#/~1holds
121
    $ref: ./paths/holds.yaml#/~1holds
122
  "/holds/{hold_id}":
122
  "/holds/{hold_id}":
123
    $ref: "paths/holds.yaml#/~1holds~1{hold_id}"
123
    $ref: "./paths/holds.yaml#/~1holds~1{hold_id}"
124
  "/holds/{hold_id}/pickup_location":
124
  "/holds/{hold_id}/pickup_location":
125
    $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location"
125
    $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location"
126
  "/holds/{hold_id}/pickup_locations":
126
  "/holds/{hold_id}/pickup_locations":
127
    $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations"
127
    $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations"
128
  "/holds/{hold_id}/priority":
128
  "/holds/{hold_id}/priority":
129
    $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1priority"
129
    $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1priority"
130
  "/holds/{hold_id}/suspension":
130
  "/holds/{hold_id}/suspension":
131
    $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1suspension"
131
    $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1suspension"
132
  /ill_backends:
132
  /ill_backends:
133
    $ref: paths/ill_backends.yaml#/~1ill_backends
133
    $ref: ./paths/ill_backends.yaml#/~1ill_backends
134
  "/ill_backends/{ill_backend_id}":
134
  "/ill_backends/{ill_backend_id}":
135
    $ref: "paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id}"
135
    $ref: "./paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id}"
136
  /illrequests:
136
  /illrequests:
137
    $ref: paths/illrequests.yaml#/~1illrequests
137
    $ref: ./paths/illrequests.yaml#/~1illrequests
138
  /import_batch_profiles:
138
  /import_batch_profiles:
139
    $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles
139
    $ref: ./paths/import_batch_profiles.yaml#/~1import_batch_profiles
140
  "/import_batch_profiles/{import_batch_profile_id}":
140
  "/import_batch_profiles/{import_batch_profile_id}":
141
    $ref: "paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}"
141
    $ref: "./paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}"
142
  /items:
142
  /items:
143
    $ref: paths/items.yaml#/~1items
143
    $ref: ./paths/items.yaml#/~1items
144
  "/items/{item_id}":
144
  "/items/{item_id}":
145
    $ref: "paths/items.yaml#/~1items~1{item_id}"
145
    $ref: "./paths/items.yaml#/~1items~1{item_id}"
146
  "/items/{item_id}/pickup_locations":
146
  "/items/{item_id}/pickup_locations":
147
    $ref: "paths/items.yaml#/~1items~1{item_id}~1pickup_locations"
147
    $ref: "./paths/items.yaml#/~1items~1{item_id}~1pickup_locations"
148
  /libraries:
148
  /libraries:
149
    $ref: paths/libraries.yaml#/~1libraries
149
    $ref: ./paths/libraries.yaml#/~1libraries
150
  "/libraries/{library_id}":
150
  "/libraries/{library_id}":
151
    $ref: "paths/libraries.yaml#/~1libraries~1{library_id}"
151
    $ref: "./paths/libraries.yaml#/~1libraries~1{library_id}"
152
  /oauth/token:
152
  /oauth/token:
153
    $ref: paths/oauth.yaml#/~1oauth~1token
153
    $ref: ./paths/oauth.yaml#/~1oauth~1token
154
  /patrons:
154
  /patrons:
155
    $ref: paths/patrons.yaml#/~1patrons
155
    $ref: ./paths/patrons.yaml#/~1patrons
156
  "/patrons/{patron_id}":
156
  "/patrons/{patron_id}":
157
    $ref: "paths/patrons.yaml#/~1patrons~1{patron_id}"
157
    $ref: "./paths/patrons.yaml#/~1patrons~1{patron_id}"
158
  "/patrons/{patron_id}/account":
158
  "/patrons/{patron_id}/account":
159
    $ref: "paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account"
159
    $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account"
160
  "/patrons/{patron_id}/account/credits":
160
  "/patrons/{patron_id}/account/credits":
161
    $ref: "paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits"
161
    $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits"
162
  "/patrons/{patron_id}/extended_attributes":
162
  "/patrons/{patron_id}/extended_attributes":
163
    $ref: "paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes"
163
    $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes"
164
  "/patrons/{patron_id}/extended_attributes/{extended_attribute_id}":
164
  "/patrons/{patron_id}/extended_attributes/{extended_attribute_id}":
165
    $ref: "paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}"
165
    $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}"
166
  "/patrons/{patron_id}/holds":
166
  "/patrons/{patron_id}/holds":
167
    $ref: "paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds"
167
    $ref: "./paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds"
168
  "/patrons/{patron_id}/password":
168
  "/patrons/{patron_id}/password":
169
    $ref: "paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password"
169
    $ref: "./paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password"
170
  "/public/biblios/{biblio_id}":
170
  "/public/biblios/{biblio_id}":
171
    $ref: "paths/biblios.yaml#/~1public~1biblios~1{biblio_id}"
171
    $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}"
172
  "/public/biblios/{biblio_id}/items":
172
  "/public/biblios/{biblio_id}/items":
173
    $ref: "paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items"
173
    $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items"
174
  /public/libraries:
174
  /public/libraries:
175
    $ref: paths/libraries.yaml#/~1public~1libraries
175
    $ref: ./paths/libraries.yaml#/~1public~1libraries
176
  "/public/libraries/{library_id}":
176
  "/public/libraries/{library_id}":
177
    $ref: "paths/libraries.yaml#/~1public~1libraries~1{library_id}"
177
    $ref: "./paths/libraries.yaml#/~1public~1libraries~1{library_id}"
178
  "/public/patrons/{patron_id}/article_requests/{article_request_id}":
178
  "/public/patrons/{patron_id}/article_requests/{article_request_id}":
179
    $ref: "paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}"
179
    $ref: "./paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}"
180
  "/public/patrons/{patron_id}/guarantors/can_see_charges":
180
  "/public/patrons/{patron_id}/guarantors/can_see_charges":
181
    $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges"
181
    $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges"
182
  "/public/patrons/{patron_id}/guarantors/can_see_checkouts":
182
  "/public/patrons/{patron_id}/guarantors/can_see_checkouts":
183
    $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"
183
    $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts"
184
  "/public/patrons/{patron_id}/password":
184
  "/public/patrons/{patron_id}/password":
185
    $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password"
185
    $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password"
186
  /quotes:
186
  /quotes:
187
    $ref: paths/quotes.yaml#/~1quotes
187
    $ref: ./paths/quotes.yaml#/~1quotes
188
  "/quotes/{quote_id}":
188
  "/quotes/{quote_id}":
189
    $ref: "paths/quotes.yaml#/~1quotes~1{quote_id}"
189
    $ref: "./paths/quotes.yaml#/~1quotes~1{quote_id}"
190
  /return_claims:
190
  /return_claims:
191
    $ref: paths/return_claims.yaml#/~1return_claims
191
    $ref: ./paths/return_claims.yaml#/~1return_claims
192
  "/return_claims/{claim_id}":
192
  "/return_claims/{claim_id}":
193
    $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}"
193
    $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}"
194
  "/return_claims/{claim_id}/notes":
194
  "/return_claims/{claim_id}/notes":
195
    $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes"
195
    $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes"
196
  "/return_claims/{claim_id}/resolve":
196
  "/return_claims/{claim_id}/resolve":
197
    $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve"
197
    $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve"
198
  "/rotas/{rota_id}/stages/{stage_id}/position":
198
  "/rotas/{rota_id}/stages/{stage_id}/position":
199
    $ref: "paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position"
199
    $ref: "./paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position"
200
  /suggestions:
200
  /suggestions:
201
    $ref: paths/suggestions.yaml#/~1suggestions
201
    $ref: ./paths/suggestions.yaml#/~1suggestions
202
  "/suggestions/{suggestion_id}":
202
  "/suggestions/{suggestion_id}":
203
    $ref: "paths/suggestions.yaml#/~1suggestions~1{suggestion_id}"
203
    $ref: "./paths/suggestions.yaml#/~1suggestions~1{suggestion_id}"
204
  /transfer_limits:
204
  /transfer_limits:
205
    $ref: paths/transfer_limits.yaml#/~1transfer_limits
205
    $ref: ./paths/transfer_limits.yaml#/~1transfer_limits
206
  /transfer_limits/batch:
206
  /transfer_limits/batch:
207
    $ref: paths/transfer_limits.yaml#/~1transfer_limits~1batch
207
    $ref: ./paths/transfer_limits.yaml#/~1transfer_limits~1batch
208
  "/transfer_limits/{limit_id}":
208
  "/transfer_limits/{limit_id}":
209
    $ref: "paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}"
209
    $ref: "./paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}"
210
parameters:
211
  advancededitormacro_id_pp:
212
    description: Advanced editor macro internal identifier
213
    in: path
214
    name: advancededitormacro_id
215
    required: true
216
    type: integer
217
  biblio_id_pp:
218
    description: Record internal identifier
219
    in: path
220
    name: biblio_id
221
    required: true
222
    type: integer
223
  cash_register_id_pp:
224
    description: Cash register internal identifier
225
    in: path
226
    name: cash_register_id
227
    required: true
228
    type: integer
229
  cashup_id_pp:
230
    description: Cashup internal identifier
231
    in: path
232
    name: cashup_id
233
    required: true
234
    type: integer
235
  checkout_id_pp:
236
    description: Internal checkout identifier
237
    in: path
238
    name: checkout_id
239
    required: true
240
    type: integer
241
  city_id_pp:
242
    description: City internal identifier
243
    in: path
244
    name: city_id
245
    required: true
246
    type: integer
247
  club_id_pp:
248
    description: Internal club identifier
249
    in: path
250
    name: club_id
251
    required: true
252
    type: integer
253
  fund_id_pp:
254
    description: Fund id
255
    in: path
256
    name: fund_id
257
    required: true
258
    type: integer
259
  hold_id_pp:
260
    description: Internal hold identifier
261
    in: path
262
    name: hold_id
263
    required: true
264
    type: integer
265
  import_batch_profile_id_pp:
266
    description: Internal profile identifier
267
    in: path
268
    name: import_batch_profile_id
269
    required: true
270
    type: integer
271
  item_id_pp:
272
    description: Internal item identifier
273
    in: path
274
    name: item_id
275
    required: true
276
    type: integer
277
  library_id_pp:
278
    description: Internal library identifier
279
    in: path
280
    name: library_id
281
    required: true
282
    type: string
283
  match:
284
    description: Matching criteria
285
    enum:
286
      - contains
287
      - exact
288
      - starts_with
289
      - ends_with
290
    in: query
291
    name: _match
292
    required: false
293
    type: string
294
  order_by:
295
    collectionFormat: csv
296
    description: Sorting criteria
297
    in: query
298
    items:
299
      type: string
300
    name: _order_by
301
    required: false
302
    type: array
303
  order_id_pp:
304
    description: Internal order identifier
305
    in: path
306
    name: order_id
307
    required: true
308
    type: integer
309
  page:
310
    description: "Page number, for paginated object listing"
311
    in: query
312
    name: _page
313
    required: false
314
    type: integer
315
  patron_id_pp:
316
    description: Internal patron identifier
317
    in: path
318
    name: patron_id
319
    required: true
320
    type: integer
321
  patron_id_qp:
322
    description: Internal patron identifier
323
    in: query
324
    name: patron_id
325
    type: integer
326
  per_page:
327
    description: "Page size, for paginated object listing"
328
    in: query
329
    name: _per_page
330
    required: false
331
    type: integer
332
  q_body:
333
    description: Query filter sent through request"s body
334
    in: body
335
    name: query
336
    required: false
337
    schema:
338
      type: object
339
  q_header:
340
    description: Query filter sent as a request header
341
    in: header
342
    name: x-koha-query
343
    required: false
344
    type: string
345
  q_param:
346
    description: Query filter sent as a request parameter
347
    in: query
348
    name: q
349
    required: false
350
    type: array
351
    items:
352
      type: string
353
    collectionFormat: multi
354
  quote_id_pp:
355
    description: Quote internal identifier
356
    in: path
357
    name: quote_id
358
    required: true
359
    type: integer
360
  seen_pp:
361
    description: Item was seen flag
362
    in: query
363
    name: seen
364
    required: false
365
    type: integer
366
  smtp_server_id_pp:
367
    description: SMTP server internal identifier
368
    in: path
369
    name: smtp_server_id
370
    required: true
371
    type: integer
372
  suggestion_id_pp:
373
    description: Internal suggestion identifier
374
    in: path
375
    name: suggestion_id
376
    required: true
377
    type: integer
378
  transfer_limit_id_pp:
379
    description: Internal transfer limit identifier
380
    in: path
381
    name: limit_id
382
    required: true
383
    type: string
384
  vendor_id_pp:
385
    description: Vendor id
386
    in: path
387
    name: vendor_id
388
    required: true
389
    type: integer
210
info:
390
info:
211
  title: Koha REST API
391
  title: Koha REST API
212
  version: 1
392
  version: 1
Lines 218-292 info: Link Here
218
    url: https://koha-community.org/
398
    url: https://koha-community.org/
219
  description: |
399
  description: |
220
    ## Introduction
400
    ## Introduction
221
401
    
222
    This API is documented in **OpenAPI format**.
402
    This API is documented in **OpenAPI format**.
223
403
    
224
    ## Authentication
404
    ## Authentication
225
405
    
226
    The API supports the following authentication mechanisms
406
    The API supports the following authentication mechanisms
227
407
    
228
    * HTTP Basic authentication
408
    * HTTP Basic authentication
229
    * OAuth2 (client credentials grant)
409
    * OAuth2 (client credentials grant)
230
    * Cookie-based
410
    * Cookie-based
231
411
    
232
    Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled
412
    Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled
233
    by system preferences.
413
    by system preferences.
234
414
    
235
    ## Errors
415
    ## Errors
236
416
    
237
    The API uses standard HTTP status codes to indicate the success or failure
417
    The API uses standard HTTP status codes to indicate the success or failure
238
    of the API call. The body of the response will be JSON in the following format:
418
    of the API call. The body of the response will be JSON in the following format:
239
419
    
240
    ```
420
    ```
241
    {
421
    {
242
      "error": "Current settings prevent the passed due date to be applied",
422
      "error": "Current settings prevent the passed due date to be applied",
243
      "error_code": "invalid_due_date"
423
      "error_code": "invalid_due_date"
244
    }
424
    }
245
    ```
425
    ```
246
426
    
247
    Note: Some routes might offer additional attributes in their error responses but that"s
427
    Note: Some routes might offer additional attributes in their error responses but that"s
248
    subject to change and thus not documented.
428
    subject to change and thus not documented.
249
429
    
250
    ## Filtering responses
430
    ## Filtering responses
251
431
    
252
    The API allows for some advanced response filtering using a JSON based query syntax. The
432
    The API allows for some advanced response filtering using a JSON based query syntax. The
253
    query can be added to the requests:
433
    query can be added to the requests:
254
434
    
255
    * as a query parameter `q=`
435
    * as a query parameter `q=`
256
    * in the request body
436
    * in the request body
257
    * in a special header `x-koha-query`
437
    * in a special header `x-koha-query`
258
438
    
259
    For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname
439
    For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname
260
    matches one of the fields as described in the particular endpoints response object.
440
    matches one of the fields as described in the particular endpoints response object.
261
441
    
262
    We can refine that with more complex matching clauses by nesting a the clause into the
442
    We can refine that with more complex matching clauses by nesting a the clause into the
263
    object; `{ "fieldname": { "clause": "value" } }`.
443
    object; `{ "fieldname": { "clause": "value" } }`.
264
444
    
265
    Available matching clauses include ">", "<", ">=", "<=", "-like", and "-not_like".
445
    Available matching clauses include ">", "<", ">=", "<=", "-like", and "-not_like".
266
446
    
267
    We can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH`
447
    We can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH`
268
    level will result in an "AND" query, whilst combinding them in an `ARRAY` wilth result in an
448
    level will result in an "AND" query, whilst combinding them in an `ARRAY` wilth result in an
269
    "OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those
449
    "OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those
270
    results with both field1 containing value2 AND field2 containing value2 for example.
450
    results with both field1 containing value2 AND field2 containing value2 for example.
271
451
    
272
    ### Examples
452
    ### Examples
273
453
    
274
    The following request would return any patron with firstname "Henry" and lastname "Acevedo";
454
    The following request would return any patron with firstname "Henry" and lastname "Acevedo";
275
455
    
276
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": "Acevedo", "firstname": "Henry" }"`
456
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": "Acevedo", "firstname": "Henry" }"`
277
457
    
278
    The following request would return any patron whose lastname begins with "Ace";
458
    The following request would return any patron whose lastname begins with "Ace";
279
459
    
280
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": { "-like": "Ace%" }"`
460
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": { "-like": "Ace%" }"`
281
461
    
282
    The following request would return any patron whilse lastname is "Acevedo" OR "Bernardo"
462
    The following request would return any patron whilse lastname is "Acevedo" OR "Bernardo"
283
463
    
284
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": [ "Acevedo", "Bernardo" ] }"`
464
    `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": [ "Acevedo", "Bernardo" ] }"`
285
465
    
286
    ## Special headers
466
    ## Special headers
287
467
    
288
    ### x-koha-library
468
    ### x-koha-library
289
469
    
290
    This optional header should be passed to give your api request a library
470
    This optional header should be passed to give your api request a library
291
    context; If it is not included in the request, then the request context
471
    context; If it is not included in the request, then the request context
292
    will default to using your api comsumer"s assigned home library.
472
    will default to using your api comsumer"s assigned home library.
(-)a/api/v1/swagger/x-primitives.yaml (-61 lines)
Lines 1-60 Link Here
1
---
2
biblio_id:
3
  type: integer
4
  description: Internal biblio identifier
5
advancededitormacro_id:
6
  type: integer
7
  description: Internal advanced editor macro identifier
8
  readOnly: true
9
patron_id:
10
  type: integer
11
  description: Internal patron identifier
12
library_id:
13
  type: string
14
  description: internally assigned library identifier
15
  maxLength: 10
16
  minLength: 1
17
limit_id:
18
  type: integer
19
  description: Internal transfer limit identifier
20
cardnumber:
21
  type:
22
    - string
23
    - "null"
24
  description: library assigned user identifier
25
city_id:
26
  type: integer
27
  description: internally assigned city identifier
28
  readOnly: true
29
email:
30
  type:
31
    - string
32
    - "null"
33
  description: primary email address for patron's primary address
34
firstname:
35
  type:
36
    - string
37
    - "null"
38
  description: patron's first name
39
phone:
40
  type:
41
    - string
42
    - "null"
43
  description: primary phone number for patron's primary address
44
surname:
45
  type:
46
    - string
47
    - "null"
48
  description: patron's last name
49
vendor_id:
50
  type: integer
51
  description: internally assigned vendor identifier
52
  readOnly: true
53
fund_id:
54
  type: integer
55
  description: internally assigned fund identifier
56
  readOnly: true
57
quote_id:
58
  type: integer
59
  description: internally assigned quote identifier
60
  readOnly: true
61
- 

Return to bug 30194