From c32109e6819d52f19ce1b8419bb040b337387041 Mon Sep 17 00:00:00 2001 From: Martin Renvoize Date: Thu, 24 Mar 2022 10:18:51 +0000 Subject: [PATCH] Bug 30194: (follow-up) Simply OpenAPI Specification This patch simplifies the specification directory further by doing the following: * Inlines paths.yml into swagger.yaml * Inlines definitions.yaml into swagger.yaml * Inlines parameters.yaml into swagger.yaml * Drops x-primitives.yaml Signed-off-by: Martin Renvoize --- api/v1/swagger/definitions.yaml | 63 --- .../definitions/advancededitormacro.yaml | 4 +- api/v1/swagger/definitions/checkout.yaml | 3 +- api/v1/swagger/definitions/checkouts.yaml | 2 +- api/v1/swagger/definitions/city.yaml | 4 +- .../definitions/club_hold_patron_holds.yaml | 2 +- api/v1/swagger/definitions/club_holds.yaml | 2 +- api/v1/swagger/definitions/fund.yaml | 4 +- api/v1/swagger/definitions/holds.yaml | 2 +- api/v1/swagger/definitions/ill_backends.yaml | 2 +- .../definitions/import_batch_profiles.yaml | 2 +- api/v1/swagger/definitions/library.yaml | 5 +- api/v1/swagger/definitions/patron.yaml | 30 +- .../swagger/definitions/patron_balance.yaml | 4 +- api/v1/swagger/definitions/quote.yaml | 3 +- api/v1/swagger/definitions/return_claim.yaml | 3 +- api/v1/swagger/definitions/vendor.yaml | 4 +- api/v1/swagger/parameters.yaml | 97 ---- .../parameters/advancededitormacro.yaml | 7 - api/v1/swagger/parameters/biblio.yaml | 7 - api/v1/swagger/parameters/cash_register.yaml | 7 - api/v1/swagger/parameters/cashup.yaml | 7 - api/v1/swagger/parameters/checkout.yaml | 13 - api/v1/swagger/parameters/city.yaml | 7 - api/v1/swagger/parameters/club.yaml | 7 - api/v1/swagger/parameters/fund.yaml | 7 - api/v1/swagger/parameters/hold.yaml | 7 - .../parameters/import_batch_profile.yaml | 7 - api/v1/swagger/parameters/item.yaml | 7 - api/v1/swagger/parameters/library.yaml | 7 - api/v1/swagger/parameters/order.yaml | 7 - api/v1/swagger/parameters/patron.yaml | 12 - api/v1/swagger/parameters/quote.yaml | 7 - api/v1/swagger/parameters/smtp_server.yaml | 7 - api/v1/swagger/parameters/suggestion.yaml | 7 - api/v1/swagger/parameters/transfer_limit.yaml | 7 - api/v1/swagger/parameters/vendor.yaml | 7 - api/v1/swagger/paths.yaml | 143 ------ api/v1/swagger/paths/acquisitions_funds.yaml | 28 +- api/v1/swagger/paths/acquisitions_orders.yaml | 84 ++-- .../swagger/paths/acquisitions_vendors.yaml | 82 ++-- .../swagger/paths/advancededitormacros.yaml | 126 ++--- api/v1/swagger/paths/article_requests.yaml | 26 +- api/v1/swagger/paths/biblios.yaml | 150 +++--- api/v1/swagger/paths/cash_registers.yaml | 38 +- api/v1/swagger/paths/checkouts.yaml | 64 +-- api/v1/swagger/paths/circulation-rules.yaml | 8 +- api/v1/swagger/paths/cities.yaml | 72 +-- api/v1/swagger/paths/clubs.yaml | 18 +- api/v1/swagger/paths/config_smtp_servers.yaml | 76 +-- api/v1/swagger/paths/holds.yaml | 172 +++---- api/v1/swagger/paths/ill_backends.yaml | 24 +- api/v1/swagger/paths/illrequests.yaml | 10 +- .../swagger/paths/import_batch_profiles.yaml | 66 +-- api/v1/swagger/paths/items.yaml | 66 +-- api/v1/swagger/paths/libraries.yaml | 104 ++--- api/v1/swagger/paths/oauth.yaml | 4 +- api/v1/swagger/paths/patrons.yaml | 90 ++-- api/v1/swagger/paths/patrons_account.yaml | 30 +- .../paths/patrons_extended_attributes.yaml | 98 ++-- api/v1/swagger/paths/patrons_holds.yaml | 28 +- api/v1/swagger/paths/patrons_password.yaml | 14 +- api/v1/swagger/paths/public_patrons.yaml | 42 +- api/v1/swagger/paths/quotes.yaml | 72 +-- api/v1/swagger/paths/return_claims.yaml | 58 +-- api/v1/swagger/paths/rotas.yaml | 12 +- api/v1/swagger/paths/suggestions.yaml | 74 +-- api/v1/swagger/paths/transfer_limits.yaml | 64 +-- api/v1/swagger/swagger.yaml | 436 +++++++++++++----- api/v1/swagger/x-primitives.yaml | 60 --- 70 files changed, 1261 insertions(+), 1558 deletions(-) delete mode 100644 api/v1/swagger/definitions.yaml delete mode 100644 api/v1/swagger/parameters.yaml delete mode 100644 api/v1/swagger/parameters/advancededitormacro.yaml delete mode 100644 api/v1/swagger/parameters/biblio.yaml delete mode 100644 api/v1/swagger/parameters/cash_register.yaml delete mode 100644 api/v1/swagger/parameters/cashup.yaml delete mode 100644 api/v1/swagger/parameters/checkout.yaml delete mode 100644 api/v1/swagger/parameters/city.yaml delete mode 100644 api/v1/swagger/parameters/club.yaml delete mode 100644 api/v1/swagger/parameters/fund.yaml delete mode 100644 api/v1/swagger/parameters/hold.yaml delete mode 100644 api/v1/swagger/parameters/import_batch_profile.yaml delete mode 100644 api/v1/swagger/parameters/item.yaml delete mode 100644 api/v1/swagger/parameters/library.yaml delete mode 100644 api/v1/swagger/parameters/order.yaml delete mode 100644 api/v1/swagger/parameters/patron.yaml delete mode 100644 api/v1/swagger/parameters/quote.yaml delete mode 100644 api/v1/swagger/parameters/smtp_server.yaml delete mode 100644 api/v1/swagger/parameters/suggestion.yaml delete mode 100644 api/v1/swagger/parameters/transfer_limit.yaml delete mode 100644 api/v1/swagger/parameters/vendor.yaml delete mode 100644 api/v1/swagger/paths.yaml delete mode 100644 api/v1/swagger/x-primitives.yaml diff --git a/api/v1/swagger/definitions.yaml b/api/v1/swagger/definitions.yaml deleted file mode 100644 index 6bdfea0929..0000000000 --- a/api/v1/swagger/definitions.yaml +++ /dev/null @@ -1,63 +0,0 @@ ---- -account_line: - $ref: definitions/account_line.yaml -advancededitormacro: - $ref: definitions/advancededitormacro.yaml -allows_renewal: - $ref: definitions/allows_renewal.yaml -basket: - $ref: definitions/basket.yaml -cashup: - $ref: definitions/cashup.yaml -checkout: - $ref: definitions/checkout.yaml -checkouts: - $ref: definitions/checkouts.yaml -circ-rule-kind: - $ref: definitions/circ-rule-kind.yaml -city: - $ref: definitions/city.yaml -error: - $ref: definitions/error.yaml -fund: - $ref: definitions/fund.yaml -hold: - $ref: definitions/hold.yaml -holds: - $ref: definitions/holds.yaml -ill_backend: - $ref: definitions/ill_backend.yaml -ill_backends: - $ref: definitions/ill_backends.yaml -import_batch_profile: - $ref: definitions/import_batch_profile.yaml -import_batch_profiles: - $ref: definitions/import_batch_profiles.yaml -invoice: - $ref: definitions/invoice.yaml -item: - $ref: definitions/item.yaml -library: - $ref: definitions/library.yaml -order: - $ref: definitions/order.yaml -patron: - $ref: definitions/patron.yaml -patron_account_credit: - $ref: definitions/patron_account_credit.yaml -patron_balance: - $ref: definitions/patron_balance.yaml -patron_extended_attribute: - $ref: definitions/patron_extended_attribute.yaml -quote: - $ref: definitions/quote.yaml -return_claim: - $ref: definitions/return_claim.yaml -smtp_server: - $ref: definitions/smtp_server.yaml -suggestion: - $ref: definitions/suggestion.yaml -transfer_limit: - $ref: definitions/transfer_limit.yaml -vendor: - $ref: definitions/vendor.yaml diff --git a/api/v1/swagger/definitions/advancededitormacro.yaml b/api/v1/swagger/definitions/advancededitormacro.yaml index c02920cfcc..d8c3d17f8b 100644 --- a/api/v1/swagger/definitions/advancededitormacro.yaml +++ b/api/v1/swagger/definitions/advancededitormacro.yaml @@ -2,7 +2,9 @@ type: object properties: macro_id: - $ref: ../x-primitives.yaml#/advancededitormacro_id + type: integer + description: Internal advanced editor macro identifier + readOnly: true name: description: macro name type: string diff --git a/api/v1/swagger/definitions/checkout.yaml b/api/v1/swagger/definitions/checkout.yaml index 9e5d4eb7ac..9ea807224d 100644 --- a/api/v1/swagger/definitions/checkout.yaml +++ b/api/v1/swagger/definitions/checkout.yaml @@ -5,7 +5,8 @@ properties: type: integer description: internally assigned checkout identifier patron_id: - $ref: ../x-primitives.yaml#/patron_id + type: integer + description: Internal patron identifier item_id: type: integer description: internal identifier of checked out item diff --git a/api/v1/swagger/definitions/checkouts.yaml b/api/v1/swagger/definitions/checkouts.yaml index e4931f57fa..18ce40d026 100644 --- a/api/v1/swagger/definitions/checkouts.yaml +++ b/api/v1/swagger/definitions/checkouts.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: checkout.yaml + $ref: "checkout.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/city.yaml b/api/v1/swagger/definitions/city.yaml index 512b91f7f0..77eb6718dd 100644 --- a/api/v1/swagger/definitions/city.yaml +++ b/api/v1/swagger/definitions/city.yaml @@ -2,7 +2,9 @@ type: object properties: city_id: - $ref: ../x-primitives.yaml#/city_id + type: integer + description: internally assigned city identifier + readOnly: true name: description: city name type: string diff --git a/api/v1/swagger/definitions/club_hold_patron_holds.yaml b/api/v1/swagger/definitions/club_hold_patron_holds.yaml index bbd3da4fa9..83e291e9c9 100644 --- a/api/v1/swagger/definitions/club_hold_patron_holds.yaml +++ b/api/v1/swagger/definitions/club_hold_patron_holds.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: club_hold_patron_hold.yaml + $ref: "club_hold_patron_hold.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/club_holds.yaml b/api/v1/swagger/definitions/club_holds.yaml index 771bac41b1..a80fdcc14e 100644 --- a/api/v1/swagger/definitions/club_holds.yaml +++ b/api/v1/swagger/definitions/club_holds.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: club_hold.yaml + $ref: "club_hold.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/fund.yaml b/api/v1/swagger/definitions/fund.yaml index f315825d9b..263f6e9073 100644 --- a/api/v1/swagger/definitions/fund.yaml +++ b/api/v1/swagger/definitions/fund.yaml @@ -2,7 +2,9 @@ type: object properties: fund_id: - $ref: ../x-primitives.yaml#/fund_id + type: integer + description: internally assigned fund identifier + readOnly: true code: type: - string diff --git a/api/v1/swagger/definitions/holds.yaml b/api/v1/swagger/definitions/holds.yaml index 5b43d6e9f8..2a5c053379 100644 --- a/api/v1/swagger/definitions/holds.yaml +++ b/api/v1/swagger/definitions/holds.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: hold.yaml + $ref: "hold.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/ill_backends.yaml b/api/v1/swagger/definitions/ill_backends.yaml index 5febc07cd8..6b48f6e4ae 100644 --- a/api/v1/swagger/definitions/ill_backends.yaml +++ b/api/v1/swagger/definitions/ill_backends.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: ill_backend.yaml + $ref: "ill_backend.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/import_batch_profiles.yaml b/api/v1/swagger/definitions/import_batch_profiles.yaml index a8e1adbcc4..88da6d38b2 100644 --- a/api/v1/swagger/definitions/import_batch_profiles.yaml +++ b/api/v1/swagger/definitions/import_batch_profiles.yaml @@ -1,5 +1,5 @@ --- type: array items: - $ref: import_batch_profile.yaml + $ref: "import_batch_profile.yaml" additionalProperties: false diff --git a/api/v1/swagger/definitions/library.yaml b/api/v1/swagger/definitions/library.yaml index 0d0d7c05f3..c3a4daaff0 100644 --- a/api/v1/swagger/definitions/library.yaml +++ b/api/v1/swagger/definitions/library.yaml @@ -2,7 +2,10 @@ type: object properties: library_id: - $ref: ../x-primitives.yaml#/library_id + type: string + description: internally assigned library identifier + maxLength: 10 + minLength: 1 name: type: string description: Printable name of library diff --git a/api/v1/swagger/definitions/patron.yaml b/api/v1/swagger/definitions/patron.yaml index cda77629ce..3d7e60b884 100644 --- a/api/v1/swagger/definitions/patron.yaml +++ b/api/v1/swagger/definitions/patron.yaml @@ -2,13 +2,23 @@ type: object properties: patron_id: - $ref: ../x-primitives.yaml#/patron_id + type: integer + description: Internal patron identifier cardnumber: - $ref: ../x-primitives.yaml#/cardnumber + type: + - string + - "null" + description: library assigned user identifier surname: - $ref: ../x-primitives.yaml#/surname + type: + - string + - "null" + description: patron's last name firstname: - $ref: ../x-primitives.yaml#/firstname + type: + - string + - "null" + description: patron's first name title: type: - string @@ -65,9 +75,15 @@ properties: - "null" description: country of patron's primary address email: - $ref: ../x-primitives.yaml#/email + type: + - string + - "null" + description: primary email address for patron's primary address phone: - $ref: ../x-primitives.yaml#/phone + type: + - string + - "null" + description: primary phone number for patron's primary address mobile: type: - string @@ -327,7 +343,7 @@ properties: type: array description: patron's extended attributes items: - $ref: patron_extended_attribute.yaml + $ref: "patron_extended_attribute.yaml" additionalProperties: false required: - surname diff --git a/api/v1/swagger/definitions/patron_balance.yaml b/api/v1/swagger/definitions/patron_balance.yaml index a78ed13d1d..7d40cb3af6 100644 --- a/api/v1/swagger/definitions/patron_balance.yaml +++ b/api/v1/swagger/definitions/patron_balance.yaml @@ -11,7 +11,7 @@ properties: lines: type: array items: - $ref: account_line.yaml + $ref: "account_line.yaml" outstanding_debits: type: object properties: @@ -20,7 +20,7 @@ properties: lines: type: array items: - $ref: account_line.yaml + $ref: "account_line.yaml" additionalProperties: false required: - balance diff --git a/api/v1/swagger/definitions/quote.yaml b/api/v1/swagger/definitions/quote.yaml index fb5704c5f4..0af727ee40 100644 --- a/api/v1/swagger/definitions/quote.yaml +++ b/api/v1/swagger/definitions/quote.yaml @@ -2,7 +2,8 @@ type: object properties: quote_id: - $ref: ../x-primitives.yaml#/quote_id + type: integer + description: internally assigned quote identifier source: description: source of the quote type: string diff --git a/api/v1/swagger/definitions/return_claim.yaml b/api/v1/swagger/definitions/return_claim.yaml index 819c83cad2..cda0cfeec0 100644 --- a/api/v1/swagger/definitions/return_claim.yaml +++ b/api/v1/swagger/definitions/return_claim.yaml @@ -20,7 +20,8 @@ properties: - "null" description: internal identifier of the claimed checkout if not longer checked out patron_id: - $ref: ../x-primitives.yaml#/patron_id + type: integer + description: Internal patron identifier notes: type: - string diff --git a/api/v1/swagger/definitions/vendor.yaml b/api/v1/swagger/definitions/vendor.yaml index ef51e7cb99..c311249f7e 100644 --- a/api/v1/swagger/definitions/vendor.yaml +++ b/api/v1/swagger/definitions/vendor.yaml @@ -2,7 +2,9 @@ type: object properties: id: - $ref: ../x-primitives.yaml#/vendor_id + type: integer + description: internally assigned vendor identifier + readOnly: true name: type: - string diff --git a/api/v1/swagger/parameters.yaml b/api/v1/swagger/parameters.yaml deleted file mode 100644 index 6b184dc315..0000000000 --- a/api/v1/swagger/parameters.yaml +++ /dev/null @@ -1,97 +0,0 @@ ---- -advancededitormacro_id_pp: - $ref: parameters/advancededitormacro.yaml#/advancededitormacro_id_pp -biblio_id_pp: - $ref: parameters/biblio.yaml#/biblio_id_pp -cash_register_id_pp: - $ref: parameters/cash_register.yaml#/cash_register_id_pp -cashup_id_pp: - $ref: parameters/cashup.yaml#/cashup_id_pp -checkout_id_pp: - $ref: parameters/checkout.yaml#/checkout_id_pp -city_id_pp: - $ref: parameters/city.yaml#/city_id_pp -club_id_pp: - $ref: parameters/club.yaml#/club_id_pp -fund_id_pp: - $ref: parameters/fund.yaml#/fund_id_pp -hold_id_pp: - $ref: parameters/hold.yaml#/hold_id_pp -import_batch_profile_id_pp: - $ref: parameters/import_batch_profile.yaml#/import_batch_profile_id_pp -item_id_pp: - $ref: parameters/item.yaml#/item_id_pp -library_id_pp: - $ref: parameters/library.yaml#/library_id_pp -match: - name: _match - in: query - required: false - description: Matching criteria - type: string - enum: - - contains - - exact - - starts_with - - ends_with -order_by: - name: _order_by - in: query - required: false - description: Sorting criteria - type: array - collectionFormat: csv - items: - type: string -order_id_pp: - $ref: parameters/order.yaml#/order_id_pp -page: - name: _page - in: query - required: false - description: Page number, for paginated object listing - type: integer -patron_id_pp: - $ref: parameters/patron.yaml#/patron_id_pp -patron_id_qp: - $ref: parameters/patron.yaml#/patron_id_qp -per_page: - name: _per_page - in: query - required: false - description: Page size, for paginated object listing - type: integer -q_body: - name: query - in: body - required: false - description: Query filter sent through request's body - schema: - type: object -q_param: - name: q - in: query - required: false - description: Query filter sent as a request parameter - type: array - items: - type: string - collectionFormat: multi -q_header: - name: x-koha-query - in: header - required: false - description: Query filter sent as a request header - type: string -quote_id_pp: - $ref: parameters/quote.yaml#/quote_id_pp -seen_pp: - $ref: parameters/checkout.yaml#/seen_pp -smtp_server_id_pp: - $ref: parameters/smtp_server.yaml#/smtp_server_id_pp -suggestion_id_pp: - $ref: parameters/suggestion.yaml#/suggestion_id_pp -transfer_limit_id_pp: - $ref: parameters/transfer_limit.yaml#/transfer_limit_id_pp -vendor_id_pp: - $ref: parameters/vendor.yaml#/vendor_id_pp diff --git a/api/v1/swagger/parameters/advancededitormacro.yaml b/api/v1/swagger/parameters/advancededitormacro.yaml deleted file mode 100644 index e3bd0e0fbd..0000000000 --- a/api/v1/swagger/parameters/advancededitormacro.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -advancededitormacro_id_pp: - name: advancededitormacro_id - in: path - description: Advanced editor macro internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/biblio.yaml b/api/v1/swagger/parameters/biblio.yaml deleted file mode 100644 index 099a2a26ea..0000000000 --- a/api/v1/swagger/parameters/biblio.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -biblio_id_pp: - name: biblio_id - in: path - description: Record internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/cash_register.yaml b/api/v1/swagger/parameters/cash_register.yaml deleted file mode 100644 index e88d4d4e01..0000000000 --- a/api/v1/swagger/parameters/cash_register.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -cash_register_id_pp: - name: cash_register_id - in: path - description: Cash register internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/cashup.yaml b/api/v1/swagger/parameters/cashup.yaml deleted file mode 100644 index a18b07b176..0000000000 --- a/api/v1/swagger/parameters/cashup.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -cashup_id_pp: - name: cashup_id - in: path - description: Cashup internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/checkout.yaml b/api/v1/swagger/parameters/checkout.yaml deleted file mode 100644 index 28c0013336..0000000000 --- a/api/v1/swagger/parameters/checkout.yaml +++ /dev/null @@ -1,13 +0,0 @@ ---- -checkout_id_pp: - name: checkout_id - in: path - description: Internal checkout identifier - required: true - type: integer -seen_pp: - name: seen - in: query - description: Item was seen flag - required: false - type: integer diff --git a/api/v1/swagger/parameters/city.yaml b/api/v1/swagger/parameters/city.yaml deleted file mode 100644 index 9ae759e31a..0000000000 --- a/api/v1/swagger/parameters/city.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -city_id_pp: - name: city_id - in: path - description: City internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/club.yaml b/api/v1/swagger/parameters/club.yaml deleted file mode 100644 index 25409e24b8..0000000000 --- a/api/v1/swagger/parameters/club.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -club_id_pp: - name: club_id - in: path - description: Internal club identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/fund.yaml b/api/v1/swagger/parameters/fund.yaml deleted file mode 100644 index c8a9536b39..0000000000 --- a/api/v1/swagger/parameters/fund.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -fund_id_pp: - name: fund_id - in: path - description: Fund id - required: true - type: integer diff --git a/api/v1/swagger/parameters/hold.yaml b/api/v1/swagger/parameters/hold.yaml deleted file mode 100644 index 77f5231c30..0000000000 --- a/api/v1/swagger/parameters/hold.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -hold_id_pp: - name: hold_id - in: path - description: Internal hold identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/import_batch_profile.yaml b/api/v1/swagger/parameters/import_batch_profile.yaml deleted file mode 100644 index 813b61db6e..0000000000 --- a/api/v1/swagger/parameters/import_batch_profile.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -import_batch_profile_id_pp: - name: import_batch_profile_id - in: path - description: Internal profile identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/item.yaml b/api/v1/swagger/parameters/item.yaml deleted file mode 100644 index bb55559b02..0000000000 --- a/api/v1/swagger/parameters/item.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -item_id_pp: - name: item_id - in: path - description: Internal item identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/library.yaml b/api/v1/swagger/parameters/library.yaml deleted file mode 100644 index b23d78b3c3..0000000000 --- a/api/v1/swagger/parameters/library.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -library_id_pp: - name: library_id - in: path - description: Internal library identifier - required: true - type: string diff --git a/api/v1/swagger/parameters/order.yaml b/api/v1/swagger/parameters/order.yaml deleted file mode 100644 index ea63e348c1..0000000000 --- a/api/v1/swagger/parameters/order.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -order_id_pp: - name: order_id - in: path - description: Internal order identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/patron.yaml b/api/v1/swagger/parameters/patron.yaml deleted file mode 100644 index 6b5c7f7529..0000000000 --- a/api/v1/swagger/parameters/patron.yaml +++ /dev/null @@ -1,12 +0,0 @@ ---- -patron_id_pp: - name: patron_id - in: path - description: Internal patron identifier - required: true - type: integer -patron_id_qp: - name: patron_id - in: query - description: Internal patron identifier - type: integer diff --git a/api/v1/swagger/parameters/quote.yaml b/api/v1/swagger/parameters/quote.yaml deleted file mode 100644 index f2d14e1e9a..0000000000 --- a/api/v1/swagger/parameters/quote.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -quote_id_pp: - name: quote_id - in: path - description: Quote internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/smtp_server.yaml b/api/v1/swagger/parameters/smtp_server.yaml deleted file mode 100644 index cfdbebc38a..0000000000 --- a/api/v1/swagger/parameters/smtp_server.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -smtp_server_id_pp: - name: smtp_server_id - in: path - description: SMTP server internal identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/suggestion.yaml b/api/v1/swagger/parameters/suggestion.yaml deleted file mode 100644 index 2f4d6320f4..0000000000 --- a/api/v1/swagger/parameters/suggestion.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -suggestion_id_pp: - name: suggestion_id - in: path - description: Internal suggestion identifier - required: true - type: integer diff --git a/api/v1/swagger/parameters/transfer_limit.yaml b/api/v1/swagger/parameters/transfer_limit.yaml deleted file mode 100644 index ee520f544f..0000000000 --- a/api/v1/swagger/parameters/transfer_limit.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -transfer_limit_id_pp: - name: limit_id - in: path - description: Internal transfer limit identifier - required: true - type: string diff --git a/api/v1/swagger/parameters/vendor.yaml b/api/v1/swagger/parameters/vendor.yaml deleted file mode 100644 index 8865b2524d..0000000000 --- a/api/v1/swagger/parameters/vendor.yaml +++ /dev/null @@ -1,7 +0,0 @@ ---- -vendor_id_pp: - name: vendor_id - in: path - description: Vendor id - required: true - type: integer diff --git a/api/v1/swagger/paths.yaml b/api/v1/swagger/paths.yaml deleted file mode 100644 index 6908fa8bb1..0000000000 --- a/api/v1/swagger/paths.yaml +++ /dev/null @@ -1,143 +0,0 @@ ---- -/oauth/token: - $ref: paths/oauth.yaml#/~1oauth~1token -/acquisitions/orders: - $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders -"/acquisitions/orders/{order_id}": - $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id} -/acquisitions/vendors: - $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors -"/acquisitions/vendors/{vendor_id}": - $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id} -/acquisitions/funds: - $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds -"/article_requests/{article_request_id}": - $ref: paths/article_requests.yaml#/~1article_requests~1{article_request_id} -"/biblios/{biblio_id}": - $ref: paths/biblios.yaml#/~1biblios~1{biblio_id} -"/biblios/{biblio_id}/checkouts": - $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts -"/biblios/{biblio_id}/items": - $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1items -"/biblios/{biblio_id}/pickup_locations": - $ref: paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations -"/cash_registers/{cash_register_id}/cashups": - $ref: paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups -"/cashups/{cashup_id}": - $ref: paths/cash_registers.yaml#/~1cashups~1{cashup_id} -/checkouts: - $ref: paths/checkouts.yaml#/~1checkouts -"/checkouts/{checkout_id}": - $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id} -"/checkouts/{checkout_id}/renewal": - $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal -/circulation-rules/kinds: - $ref: paths/circulation-rules.yaml#/~1circulation-rules~1kinds -/cities: - $ref: paths/cities.yaml#/~1cities -"/cities/{city_id}": - $ref: paths/cities.yaml#/~1cities~1{city_id} -"/clubs/{club_id}/holds": - $ref: paths/clubs.yaml#/~1clubs~1{club_id}~1holds -/config/smtp_servers: - $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers -"/config/smtp_servers/{smtp_server_id}": - $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id} -/holds: - $ref: paths/holds.yaml#/~1holds -"/holds/{hold_id}": - $ref: paths/holds.yaml#/~1holds~1{hold_id} -"/holds/{hold_id}/priority": - $ref: paths/holds.yaml#/~1holds~1{hold_id}~1priority -"/holds/{hold_id}/suspension": - $ref: paths/holds.yaml#/~1holds~1{hold_id}~1suspension -"/holds/{hold_id}/pickup_locations": - $ref: paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations -"/holds/{hold_id}/pickup_location": - $ref: paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location -/items: - $ref: paths/items.yaml#/~1items -"/items/{item_id}": - $ref: paths/items.yaml#/~1items~1{item_id} -"/items/{item_id}/pickup_locations": - $ref: paths/items.yaml#/~1items~1{item_id}~1pickup_locations -/libraries: - $ref: paths/libraries.yaml#/~1libraries -"/libraries/{library_id}": - $ref: paths/libraries.yaml#/~1libraries~1{library_id} -/transfer_limits: - $ref: paths/transfer_limits.yaml#/~1transfer_limits -"/transfer_limits/{limit_id}": - $ref: paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id} -/transfer_limits/batch: - $ref: paths/transfer_limits.yaml#/~1transfer_limits~1batch -"/checkouts/{checkout_id}/allows_renewal": - $ref: paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal -/advanced_editor/macros: - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros -"/advanced_editor/macros/{advancededitormacro_id}": - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id} -/advanced_editor/macros/shared: - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared -"/advanced_editor/macros/shared/{advancededitormacro_id}": - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id} -/patrons: - $ref: paths/patrons.yaml#/~1patrons -"/patrons/{patron_id}": - $ref: paths/patrons.yaml#/~1patrons~1{patron_id} -"/patrons/{patron_id}/account": - $ref: paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account -"/patrons/{patron_id}/account/credits": - $ref: paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits -"/patrons/{patron_id}/extended_attributes": - $ref: paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes -"/patrons/{patron_id}/extended_attributes/{extended_attribute_id}": - $ref: paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id} -"/patrons/{patron_id}/holds": - $ref: paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds -"/patrons/{patron_id}/password": - $ref: paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password -/ill_backends: - $ref: paths/ill_backends.yaml#/~1ill_backends -"/ill_backends/{ill_backend_id}": - $ref: paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id} -/illrequests: - $ref: paths/illrequests.yaml#/~1illrequests -/import_batch_profiles: - $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles -"/import_batch_profiles/{import_batch_profile_id}": - $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id} -"/rotas/{rota_id}/stages/{stage_id}/position": - $ref: paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position -"/public/biblios/{biblio_id}": - $ref: paths/biblios.yaml#/~1public~1biblios~1{biblio_id} -"/public/biblios/{biblio_id}/items": - $ref: paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items -/public/libraries: - $ref: paths/libraries.yaml#/~1public~1libraries -"/public/libraries/{library_id}": - $ref: paths/libraries.yaml#/~1public~1libraries~1{library_id} -"/public/patrons/{patron_id}/article_requests/{article_request_id}": - $ref: paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id} -"/public/patrons/{patron_id}/password": - $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password -"/public/patrons/{patron_id}/guarantors/can_see_charges": - $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges -"/public/patrons/{patron_id}/guarantors/can_see_checkouts": - $ref: paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts -/quotes: - $ref: paths/quotes.yaml#/~1quotes -"/quotes/{quote_id}": - $ref: paths/quotes.yaml#/~1quotes~1{quote_id} -/return_claims: - $ref: paths/return_claims.yaml#/~1return_claims -"/return_claims/{claim_id}/notes": - $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes -"/return_claims/{claim_id}/resolve": - $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve -"/return_claims/{claim_id}": - $ref: paths/return_claims.yaml#/~1return_claims~1{claim_id} -/suggestions: - $ref: paths/suggestions.yaml#/~1suggestions -"/suggestions/{suggestion_id}": - $ref: paths/suggestions.yaml#/~1suggestions~1{suggestion_id} diff --git a/api/v1/swagger/paths/acquisitions_funds.yaml b/api/v1/swagger/paths/acquisitions_funds.yaml index c0bb41e20f..fc3edad83c 100644 --- a/api/v1/swagger/paths/acquisitions_funds.yaml +++ b/api/v1/swagger/paths/acquisitions_funds.yaml @@ -19,43 +19,43 @@ description: Display only the funds that belongs to the given patron ID required: false type: integer - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of funds schema: type: array items: - $ref: ../definitions.yaml#/fund + $ref: "../swagger.yaml#/definitions/fund" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Fund not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: - + * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: budget_manage_all diff --git a/api/v1/swagger/paths/acquisitions_orders.yaml b/api/v1/swagger/paths/acquisitions_orders.yaml index 717ca7a7ba..46727236c9 100644 --- a/api/v1/swagger/paths/acquisitions_orders.yaml +++ b/api/v1/swagger/paths/acquisitions_orders.yaml @@ -35,43 +35,43 @@ description: If only active orders should be listed required: false type: boolean - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of orders schema: type: array items: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Order not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: @@ -103,41 +103,41 @@ description: A JSON object representing an order required: true schema: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" produces: - application/json responses: "201": description: Order added schema: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating the resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: order_manage @@ -149,37 +149,37 @@ - orders summary: Get order parameters: - - $ref: ../parameters.yaml#/order_id_pp + - $ref: "../swagger.yaml#/parameters/order_id_pp" produces: - application/json responses: "200": description: An order schema: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Order not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: order_manage @@ -204,43 +204,43 @@ - orders summary: Update order parameters: - - $ref: ../parameters.yaml#/order_id_pp + - $ref: "../swagger.yaml#/parameters/order_id_pp" - name: body in: body description: A JSON object representing an order required: true schema: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" produces: - application/json responses: "200": description: An order schema: - $ref: ../definitions.yaml#/order + $ref: "../swagger.yaml#/definitions/order" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Order not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: order_manage @@ -251,7 +251,7 @@ - orders summary: Delete order parameters: - - $ref: ../parameters.yaml#/order_id_pp + - $ref: "../swagger.yaml#/parameters/order_id_pp" produces: - application/json responses: @@ -260,26 +260,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Order not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: order_manage diff --git a/api/v1/swagger/paths/acquisitions_vendors.yaml b/api/v1/swagger/paths/acquisitions_vendors.yaml index 1d816d6364..bb7050af51 100644 --- a/api/v1/swagger/paths/acquisitions_vendors.yaml +++ b/api/v1/swagger/paths/acquisitions_vendors.yaml @@ -19,43 +19,43 @@ description: Case insensitive search on vendor's account number required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of vendors schema: type: array items: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Vendor not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: vendors_manage @@ -71,37 +71,37 @@ description: A JSON object representing a vendor required: true schema: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" produces: - application/json responses: "201": description: Vendor added schema: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Vendor not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: vendors_manage @@ -113,37 +113,37 @@ - vendors summary: Get vendor parameters: - - $ref: ../parameters.yaml#/vendor_id_pp + - $ref: "../swagger.yaml#/parameters/vendor_id_pp" produces: - application/json responses: "200": description: A vendor schema: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Vendor not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: vendors_manage @@ -154,43 +154,43 @@ - vendors summary: Update vendor parameters: - - $ref: ../parameters.yaml#/vendor_id_pp + - $ref: "../swagger.yaml#/parameters/vendor_id_pp" - name: body in: body description: A JSON object representing a vendor required: true schema: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" produces: - application/json responses: "200": description: A vendor schema: - $ref: ../definitions.yaml#/vendor + $ref: "../swagger.yaml#/definitions/vendor" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Vendor not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: vendors_manage @@ -201,7 +201,7 @@ - vendors summary: Delete vendor parameters: - - $ref: ../parameters.yaml#/vendor_id_pp + - $ref: "../swagger.yaml#/parameters/vendor_id_pp" produces: - application/json responses: @@ -210,26 +210,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Vendor not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: acquisition: vendors_manage diff --git a/api/v1/swagger/paths/advancededitormacros.yaml b/api/v1/swagger/paths/advancededitormacros.yaml index 8fdbd9ef93..edd354d2bc 100644 --- a/api/v1/swagger/paths/advancededitormacros.yaml +++ b/api/v1/swagger/paths/advancededitormacros.yaml @@ -29,35 +29,35 @@ description: Search on shared macros required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of macros schema: type: array items: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -73,30 +73,30 @@ description: A JSON object containing informations about the new macro required: true schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" produces: - application/json responses: "201": description: Macro added schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -113,30 +113,30 @@ description: A JSON object containing informations about the new macro required: true schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" produces: - application/json responses: "201": description: Macro added schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: @@ -150,30 +150,30 @@ - macros summary: Get advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" produces: - application/json responses: "200": description: A macro schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: AdvancedEditorMacro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -184,40 +184,40 @@ - macros summary: Update advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" - name: body in: body description: An advanced editor macro object required: true schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" produces: - application/json responses: "200": description: An advanced editor macro schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Macro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -228,7 +228,7 @@ - macros summary: Delete advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" produces: - application/json responses: @@ -239,23 +239,23 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Macro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -267,30 +267,30 @@ - macros summary: Get shared advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" produces: - application/json responses: "200": description: A macro schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: AdvancedEditorMacro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: advanced_editor @@ -301,40 +301,40 @@ - macros summary: Update shared advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" - name: body in: body description: An advanced editor macro object required: true schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" produces: - application/json responses: "200": description: An advanced editor macro schema: - $ref: ../definitions.yaml#/advancededitormacro + $ref: "../swagger.yaml#/definitions/advancededitormacro" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Macro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: @@ -347,7 +347,7 @@ - macros summary: Delete shared advanced editor macro parameters: - - $ref: ../parameters.yaml#/advancededitormacro_id_pp + - $ref: "../swagger.yaml#/parameters/advancededitormacro_id_pp" produces: - application/json responses: @@ -358,23 +358,23 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Macro not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: diff --git a/api/v1/swagger/paths/article_requests.yaml b/api/v1/swagger/paths/article_requests.yaml index 2b472cecbf..d0fc698557 100644 --- a/api/v1/swagger/paths/article_requests.yaml +++ b/api/v1/swagger/paths/article_requests.yaml @@ -30,30 +30,30 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -65,7 +65,7 @@ - article_requests summary: Cancel patron's article requests parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: article_request_id in: path description: Article request identifier @@ -89,29 +89,29 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: allow-owner: true diff --git a/api/v1/swagger/paths/biblios.yaml b/api/v1/swagger/paths/biblios.yaml index c48873fb90..cddb61c49a 100644 --- a/api/v1/swagger/paths/biblios.yaml +++ b/api/v1/swagger/paths/biblios.yaml @@ -7,7 +7,7 @@ - biblios summary: Get biblio parameters: - - $ref: ../parameters.yaml#/biblio_id_pp + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" produces: - application/json - application/marcxml+xml @@ -20,15 +20,15 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "406": description: Not acceptable schema: @@ -42,11 +42,11 @@ * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -57,7 +57,7 @@ - biblios summary: Delete biblio parameters: - - $ref: ../parameters.yaml#/biblio_id_pp + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" produces: - application/json responses: @@ -68,27 +68,27 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Unable to perform action on biblio schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: editcatalogue: edit_catalogue @@ -100,14 +100,14 @@ - checkouts summary: List checkouts for a biblio parameters: - - $ref: ../parameters.yaml#/biblio_id_pp - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" - name: checked_in in: query description: By default, current checkouts are returned, when this is true then @@ -119,26 +119,26 @@ "200": description: A list of checkouts schema: - $ref: ../definitions.yaml#/checkouts + $ref: "../swagger.yaml#/definitions/checkouts" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -155,14 +155,14 @@ - biblios summary: Get items for a biblio parameters: - - $ref: ../parameters.yaml#/biblio_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -173,19 +173,19 @@ schema: type: array items: - $ref: ../definitions.yaml#/item + $ref: "../swagger.yaml#/definitions/item" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "406": description: Not acceptable schema: @@ -199,11 +199,11 @@ * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -215,19 +215,19 @@ - biblios summary: Get valid pickup locations for a biblio parameters: - - $ref: ../parameters.yaml#/biblio_id_pp + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" - name: patron_id in: query description: Internal patron identifier required: true type: integer - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -238,34 +238,34 @@ schema: type: array items: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: place_holds @@ -277,7 +277,7 @@ - biblios summary: Get biblio (public) parameters: - - $ref: ../parameters.yaml#/biblio_id_pp + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" produces: - application/marcxml+xml - application/marc-in-json @@ -289,15 +289,15 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "406": description: Not acceptable schema: @@ -311,11 +311,11 @@ * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "/public/biblios/{biblio_id}/items": get: x-mojo-to: Biblios#get_items_public @@ -324,14 +324,14 @@ - biblios - items parameters: - - $ref: ../parameters.yaml#/biblio_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/biblio_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -342,19 +342,19 @@ schema: type: array items: - $ref: ../definitions.yaml#/item + $ref: "../swagger.yaml#/definitions/item" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "406": description: Not acceptable schema: @@ -368,8 +368,8 @@ * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" diff --git a/api/v1/swagger/paths/cash_registers.yaml b/api/v1/swagger/paths/cash_registers.yaml index fb3b27a5c1..63d433888f 100644 --- a/api/v1/swagger/paths/cash_registers.yaml +++ b/api/v1/swagger/paths/cash_registers.yaml @@ -9,40 +9,40 @@ produces: - application/json parameters: - - $ref: ../parameters.yaml#/cash_register_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/cash_register_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: Cashups performed on this register schema: type: array items: - $ref: ../definitions.yaml#/cashup + $ref: "../swagger.yaml#/definitions/cashup" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Register not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: cash_management: cashup @@ -56,33 +56,33 @@ - cashups summary: Get cashup parameters: - - $ref: ../parameters.yaml#/cashup_id_pp + - $ref: "../swagger.yaml#/parameters/cashup_id_pp" produces: - application/json responses: "200": description: A cashup schema: - $ref: ../definitions.yaml#/cashup + $ref: "../swagger.yaml#/definitions/cashup" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: cash_management: cashup diff --git a/api/v1/swagger/paths/checkouts.yaml b/api/v1/swagger/paths/checkouts.yaml index c90204fdb4..4bd9221826 100644 --- a/api/v1/swagger/paths/checkouts.yaml +++ b/api/v1/swagger/paths/checkouts.yaml @@ -7,14 +7,14 @@ - checkouts summary: List checkouts parameters: - - $ref: ../parameters.yaml#/patron_id_qp - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/patron_id_qp" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" - name: checked_in in: query description: By default, current checkouts are returned, when this is true then @@ -26,26 +26,26 @@ "200": description: A list of checkouts schema: - $ref: ../definitions.yaml#/checkouts + $ref: "../swagger.yaml#/definitions/checkouts" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -59,33 +59,33 @@ - checkouts summary: Get checkout parameters: - - $ref: ../parameters.yaml#/checkout_id_pp + - $ref: "../swagger.yaml#/parameters/checkout_id_pp" produces: - application/json responses: "200": description: Updated borrower's checkout schema: - $ref: ../definitions.yaml#/checkout + $ref: "../swagger.yaml#/definitions/checkout" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -99,34 +99,34 @@ - checkouts summary: Renew a checkout parameters: - - $ref: ../parameters.yaml#/checkout_id_pp - - $ref: ../parameters.yaml#/seen_pp + - $ref: "../swagger.yaml#/parameters/checkout_id_pp" + - $ref: "../swagger.yaml#/parameters/seen_pp" produces: - application/json responses: "201": description: Updated borrower's checkout schema: - $ref: ../definitions.yaml#/checkout + $ref: "../swagger.yaml#/definitions/checkout" "403": description: Cannot renew checkout schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -138,33 +138,33 @@ - checkouts summary: Get renewability for a checkout parameters: - - $ref: ../parameters.yaml#/checkout_id_pp + - $ref: "../swagger.yaml#/parameters/checkout_id_pp" produces: - application/json responses: "200": description: Checkout renewability information schema: - $ref: ../definitions.yaml#/allows_renewal + $ref: "../swagger.yaml#/definitions/allows_renewal" "403": description: Forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions diff --git a/api/v1/swagger/paths/circulation-rules.yaml b/api/v1/swagger/paths/circulation-rules.yaml index eaee8ee9fe..545f15458a 100644 --- a/api/v1/swagger/paths/circulation-rules.yaml +++ b/api/v1/swagger/paths/circulation-rules.yaml @@ -14,19 +14,19 @@ schema: type: object additionalProperties: - $ref: ../definitions.yaml#/circ-rule-kind + $ref: "../swagger.yaml#/definitions/circ-rule-kind" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" diff --git a/api/v1/swagger/paths/cities.yaml b/api/v1/swagger/paths/cities.yaml index 15bbf8a28b..b8a3277bbf 100644 --- a/api/v1/swagger/paths/cities.yaml +++ b/api/v1/swagger/paths/cities.yaml @@ -29,35 +29,35 @@ description: Case Insensative search on city postal code required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of cities schema: type: array items: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -73,33 +73,33 @@ description: A JSON object containing informations about the new hold required: true schema: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" produces: - application/json responses: "201": description: City added schema: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_cities @@ -111,29 +111,29 @@ - cities summary: Get city parameters: - - $ref: ../parameters.yaml#/city_id_pp + - $ref: "../swagger.yaml#/parameters/city_id_pp" produces: - application/json responses: "200": description: A city schema: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" "404": description: City not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -144,40 +144,40 @@ - cities summary: Update city parameters: - - $ref: ../parameters.yaml#/city_id_pp + - $ref: "../swagger.yaml#/parameters/city_id_pp" - name: body in: body description: A city object required: true schema: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" produces: - application/json responses: "200": description: A city schema: - $ref: ../definitions.yaml#/city + $ref: "../swagger.yaml#/definitions/city" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: City not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_cities @@ -188,7 +188,7 @@ - cities summary: Delete city parameters: - - $ref: ../parameters.yaml#/city_id_pp + - $ref: "../swagger.yaml#/parameters/city_id_pp" produces: - application/json responses: @@ -197,23 +197,23 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: City not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_cities diff --git a/api/v1/swagger/paths/clubs.yaml b/api/v1/swagger/paths/clubs.yaml index c47574c3eb..7e09954d7c 100644 --- a/api/v1/swagger/paths/clubs.yaml +++ b/api/v1/swagger/paths/clubs.yaml @@ -7,7 +7,7 @@ - clubs summary: Add a club hold parameters: - - $ref: ../parameters.yaml#/club_id_pp + - $ref: "../swagger.yaml#/parameters/club_id_pp" - name: body in: body description: A JSON object containing informations about the new hold @@ -59,38 +59,38 @@ "201": description: Created club hold schema: - $ref: ../definitions/club_hold.yaml + $ref: "../definitions/club_hold.yaml" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Club not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" diff --git a/api/v1/swagger/paths/config_smtp_servers.yaml b/api/v1/swagger/paths/config_smtp_servers.yaml index f2cfd7354a..f2e71eb14f 100644 --- a/api/v1/swagger/paths/config_smtp_servers.yaml +++ b/api/v1/swagger/paths/config_smtp_servers.yaml @@ -9,35 +9,35 @@ produces: - application/json parameters: - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of SMTP servers schema: type: array items: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_smtp_servers @@ -53,37 +53,37 @@ description: A JSON object representing a new SMTP server configuration required: true schema: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" produces: - application/json responses: "201": description: An SMTP server object schema: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_smtp_servers @@ -95,33 +95,33 @@ - smtp_servers summary: Get SMTP server parameters: - - $ref: ../parameters.yaml#/smtp_server_id_pp + - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp" produces: - application/json responses: "200": description: An SMTP server object schema: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" "404": description: Object not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict updating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_smtp_servers @@ -132,43 +132,43 @@ - smtp_servers summary: Update SMTP server parameters: - - $ref: ../parameters.yaml#/smtp_server_id_pp + - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp" - name: body in: body description: An SMTP server object required: true schema: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" produces: - application/json responses: "200": description: An SMTP server object schema: - $ref: ../definitions.yaml#/smtp_server + $ref: "../swagger.yaml#/definitions/smtp_server" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Object not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_smtp_servers @@ -179,7 +179,7 @@ - smtp_servers summary: Delete SMTP server parameters: - - $ref: ../parameters.yaml#/smtp_server_id_pp + - $ref: "../swagger.yaml#/parameters/smtp_server_id_pp" produces: - application/json responses: @@ -188,26 +188,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Object not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_smtp_servers diff --git a/api/v1/swagger/paths/holds.yaml b/api/v1/swagger/paths/holds.yaml index ea778c1a90..b42326fa3e 100644 --- a/api/v1/swagger/paths/holds.yaml +++ b/api/v1/swagger/paths/holds.yaml @@ -77,43 +77,43 @@ in: query description: Non priority hold type: boolean - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: "200": description: A list of holds schema: - $ref: ../definitions.yaml#/holds + $ref: "../swagger.yaml#/definitions/holds" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Borrower not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -191,34 +191,34 @@ "201": description: Created hold schema: - $ref: ../definitions.yaml#/hold + $ref: "../swagger.yaml#/definitions/hold" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Borrower not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -230,7 +230,7 @@ - holds summary: Update hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" - name: body in: body description: A JSON object containing fields to modify @@ -258,34 +258,34 @@ "200": description: Updated hold schema: - $ref: ../definitions.yaml#/hold + $ref: "../swagger.yaml#/definitions/hold" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -298,7 +298,7 @@ description: This route is being deprecated and will be removed in future releases. Please migrate your project to use PATCH /holds/{hold_id} instead. parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" - name: body in: body description: A JSON object containing fields to modify @@ -326,34 +326,34 @@ "200": description: Updated hold schema: - $ref: ../definitions.yaml#/hold + $ref: "../swagger.yaml#/definitions/hold" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -364,7 +364,7 @@ - holds summary: Cancel hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" produces: - application/json responses: @@ -373,26 +373,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -404,7 +404,7 @@ - holds summary: Update priority for the hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" - name: body in: body description: An integer representing the new priority to be set for the hold @@ -421,30 +421,30 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Unable to perform action on biblio schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: modify_holds_priority @@ -456,7 +456,7 @@ - holds summary: Suspend the hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" - name: body in: body description: A JSON object containing fields to modify @@ -479,30 +479,30 @@ "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -513,7 +513,7 @@ - holds summary: Resume hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" consumes: - application/json produces: @@ -524,30 +524,30 @@ "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: "1" @@ -564,14 +564,14 @@ in: header type: string required: false - - $ref: ../parameters.yaml#/hold_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/hold_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -580,34 +580,34 @@ schema: type: array items: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold pickup location list not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: place_holds @@ -620,7 +620,7 @@ summary: Update pickup location for the hold description: Set a new pickup location for the hold parameters: - - $ref: ../parameters.yaml#/hold_id_pp + - $ref: "../swagger.yaml#/parameters/hold_id_pp" - name: body in: body description: Pickup location @@ -647,31 +647,31 @@ "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Unable to perform action on hold schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: Internal error schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: place_holds diff --git a/api/v1/swagger/paths/ill_backends.yaml b/api/v1/swagger/paths/ill_backends.yaml index cbd6377313..3537c37cca 100644 --- a/api/v1/swagger/paths/ill_backends.yaml +++ b/api/v1/swagger/paths/ill_backends.yaml @@ -13,30 +13,30 @@ "200": description: A list of ILL backends schema: - $ref: ../definitions.yaml#/ill_backends + $ref: "../swagger.yaml#/definitions/ill_backends" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: ILL backends not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: ill: "1" @@ -59,30 +59,30 @@ "200": description: An ILL backends schema: - $ref: ../definitions.yaml#/ill_backend + $ref: "../swagger.yaml#/definitions/ill_backend" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: ILL backends not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: ill: "1" diff --git a/api/v1/swagger/paths/illrequests.yaml b/api/v1/swagger/paths/illrequests.yaml index 38bc2091d5..1e3224bda0 100644 --- a/api/v1/swagger/paths/illrequests.yaml +++ b/api/v1/swagger/paths/illrequests.yaml @@ -106,26 +106,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: ILL requests not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: ill: "1" diff --git a/api/v1/swagger/paths/import_batch_profiles.yaml b/api/v1/swagger/paths/import_batch_profiles.yaml index da2caa54b9..bae3bb51c5 100644 --- a/api/v1/swagger/paths/import_batch_profiles.yaml +++ b/api/v1/swagger/paths/import_batch_profiles.yaml @@ -12,13 +12,13 @@ description: Search on profile's name required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -27,26 +27,26 @@ "200": description: A list of import batch profiles schema: - $ref: ../definitions.yaml#/import_batch_profiles + $ref: "../swagger.yaml#/definitions/import_batch_profiles" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: stage_marc_import @@ -126,34 +126,34 @@ "201": description: Created Profile schema: - $ref: ../definitions.yaml#/import_batch_profile + $ref: "../swagger.yaml#/definitions/import_batch_profile" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Borrower not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: stage_marc_import @@ -165,7 +165,7 @@ - batch_import_profiles summary: Update batch import profile parameters: - - $ref: ../parameters.yaml#/import_batch_profile_id_pp + - $ref: "../swagger.yaml#/parameters/import_batch_profile_id_pp" - name: body in: body description: A JSON object containing a import batch profile @@ -235,34 +235,34 @@ "200": description: Updated profile schema: - $ref: ../definitions.yaml#/import_batch_profile + $ref: "../swagger.yaml#/definitions/import_batch_profile" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Borrower not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: stage_marc_import @@ -273,7 +273,7 @@ - batch_import_profiles summary: Delete batch import profile parameters: - - $ref: ../parameters.yaml#/import_batch_profile_id_pp + - $ref: "../swagger.yaml#/parameters/import_batch_profile_id_pp" produces: - application/json responses: @@ -282,26 +282,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Hold not allowed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Hold not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: stage_marc_import diff --git a/api/v1/swagger/paths/items.yaml b/api/v1/swagger/paths/items.yaml index bbd391e51e..806d777b90 100644 --- a/api/v1/swagger/paths/items.yaml +++ b/api/v1/swagger/paths/items.yaml @@ -12,13 +12,13 @@ description: Search on the item's barcode required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -29,26 +29,26 @@ schema: type: array items: - $ref: ../definitions.yaml#/item + $ref: "../swagger.yaml#/definitions/item" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -60,7 +60,7 @@ - items summary: Get item parameters: - - $ref: ../parameters.yaml#/item_id_pp + - $ref: "../swagger.yaml#/parameters/item_id_pp" consumes: - application/json produces: @@ -69,26 +69,26 @@ "200": description: An item schema: - $ref: ../definitions.yaml#/item + $ref: "../swagger.yaml#/definitions/item" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Item not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -100,19 +100,19 @@ tags: - items parameters: - - $ref: ../parameters.yaml#/item_id_pp + - $ref: "../swagger.yaml#/parameters/item_id_pp" - name: patron_id in: query description: Internal patron identifier required: true type: integer - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" consumes: - application/json produces: @@ -123,34 +123,34 @@ schema: type: array items: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "400": description: Missing or wrong parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Biblio not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: reserveforothers: place_holds diff --git a/api/v1/swagger/paths/libraries.yaml b/api/v1/swagger/paths/libraries.yaml index db80d14178..754f87bf07 100644 --- a/api/v1/swagger/paths/libraries.yaml +++ b/api/v1/swagger/paths/libraries.yaml @@ -92,13 +92,13 @@ description: Case insensitive 'starts-with' search on OPAC info required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -107,18 +107,18 @@ schema: type: array items: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -136,41 +136,41 @@ description: A JSON object containing informations about the new library required: true schema: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" produces: - application/json responses: "201": description: Library added schema: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_libraries @@ -182,18 +182,18 @@ - libraries summary: Get library parameters: - - $ref: ../parameters.yaml#/library_id_pp + - $ref: "../swagger.yaml#/parameters/library_id_pp" produces: - application/json responses: "200": description: A library schema: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -206,13 +206,13 @@ - libraries summary: Update library parameters: - - $ref: ../parameters.yaml#/library_id_pp + - $ref: "../swagger.yaml#/parameters/library_id_pp" - name: body in: body description: A JSON object containing information on the library required: true schema: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" consumes: - application/json produces: @@ -221,34 +221,34 @@ "200": description: A library schema: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_libraries @@ -259,7 +259,7 @@ - libraries summary: Delete library parameters: - - $ref: ../parameters.yaml#/library_id_pp + - $ref: "../swagger.yaml#/parameters/library_id_pp" produces: - application/json responses: @@ -270,26 +270,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_libraries @@ -301,13 +301,13 @@ - libraries summary: List libraries parameters: - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -316,18 +316,18 @@ schema: type: array items: - $ref: ../definitions.yaml#/library + $ref: "../swagger.yaml#/definitions/library" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "/public/libraries/{library_id}": get: x-mojo-to: Libraries#get @@ -336,7 +336,7 @@ - libraries summary: Get library (public) parameters: - - $ref: ../parameters.yaml#/library_id_pp + - $ref: "../swagger.yaml#/parameters/library_id_pp" produces: - application/json responses: @@ -345,15 +345,15 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "406": description: Not acceptable schema: @@ -367,8 +367,8 @@ * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" diff --git a/api/v1/swagger/paths/oauth.yaml b/api/v1/swagger/paths/oauth.yaml index e42dc070db..1d74ed6f1f 100644 --- a/api/v1/swagger/paths/oauth.yaml +++ b/api/v1/swagger/paths/oauth.yaml @@ -38,8 +38,8 @@ "400": description: Bad Request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" diff --git a/api/v1/swagger/paths/patrons.yaml b/api/v1/swagger/paths/patrons.yaml index 76fe6c1bbb..50a672643f 100644 --- a/api/v1/swagger/paths/patrons.yaml +++ b/api/v1/swagger/paths/patrons.yaml @@ -344,39 +344,39 @@ description: Search on login_attempts required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of patrons schema: type: array items: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: "1" @@ -394,7 +394,7 @@ description: A JSON object containing information about the new patron required: true schema: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" consumes: - application/json produces: @@ -404,38 +404,38 @@ description: A successfully created patron schema: items: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" "400": description: Bad parameter schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Resource not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -447,37 +447,37 @@ - patrons summary: Get patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" produces: - application/json responses: "200": description: A patron schema: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -490,13 +490,13 @@ - patrons summary: Update patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON object containing new information about existing patron required: true schema: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" consumes: - application/json produces: @@ -506,34 +506,34 @@ description: A successfully updated patron schema: items: - $ref: ../definitions.yaml#/patron + $ref: "../swagger.yaml#/definitions/patron" "400": description: Bad parameter schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Resource not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in updating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: "1" @@ -544,7 +544,7 @@ - patrons summary: Delete patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" produces: - application/json responses: @@ -553,19 +553,19 @@ "400": description: Patron deletion failed schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: | Conflict. Possible `error_code` attribute values: @@ -575,18 +575,18 @@ * `has_guarantees`: The patron has guarantees * `is_anonymous_patron`: The system-wide anonymous patron cannot be deleted schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: delete_borrowers diff --git a/api/v1/swagger/paths/patrons_account.yaml b/api/v1/swagger/paths/patrons_account.yaml index 90043d9494..3f763a7aa4 100644 --- a/api/v1/swagger/paths/patrons_account.yaml +++ b/api/v1/swagger/paths/patrons_account.yaml @@ -7,37 +7,37 @@ - patrons summary: Get account information for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" produces: - application/json responses: "200": description: Patron's account balance schema: - $ref: ../definitions.yaml#/patron_balance + $ref: "../swagger.yaml#/definitions/patron_balance" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -50,43 +50,43 @@ - patrons summary: Add credit to a patron's account parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON object containing credit information required: true schema: - $ref: ../definitions.yaml#/patron_account_credit + $ref: "../swagger.yaml#/definitions/patron_account_credit" produces: - application/json responses: "201": description: Credit added schema: - $ref: ../definitions.yaml#/account_line + $ref: "../swagger.yaml#/definitions/account_line" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: updatecharges: remaining_permissions diff --git a/api/v1/swagger/paths/patrons_extended_attributes.yaml b/api/v1/swagger/paths/patrons_extended_attributes.yaml index ecaf2c6678..ac9e2aea66 100644 --- a/api/v1/swagger/paths/patrons_extended_attributes.yaml +++ b/api/v1/swagger/paths/patrons_extended_attributes.yaml @@ -7,14 +7,14 @@ - patrons summary: List extended attributes for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/patron_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -23,30 +23,30 @@ schema: type: array items: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -57,51 +57,51 @@ - patrons summary: Add extended attribute for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON representation of the patron extended attribute required: true schema: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" produces: - application/json responses: "201": description: A successfully created patron extended attribute schema: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" "400": description: Bad parameter schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -112,7 +112,7 @@ - patrons summary: Overwrite extended attributes for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON representation of the patron extended attribute @@ -120,7 +120,7 @@ schema: type: array items: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" produces: - application/json responses: @@ -129,38 +129,38 @@ schema: type: array items: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" "400": description: Bad parameters schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -172,7 +172,7 @@ - patrons summary: Update extended attribute parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: extended_attribute_id in: path description: Internal patron extended attribute identifier @@ -196,38 +196,38 @@ "200": description: A successfully updated patron extended attribute schema: - $ref: ../definitions.yaml#/patron_extended_attribute + $ref: "../swagger.yaml#/definitions/patron_extended_attribute" "400": description: Bad parameter schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Object not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in updating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers @@ -238,7 +238,7 @@ - patrons summary: Delete extended attribute parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: extended_attribute_id in: path description: Internal patron extended attribute identifier @@ -252,26 +252,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers diff --git a/api/v1/swagger/paths/patrons_holds.yaml b/api/v1/swagger/paths/patrons_holds.yaml index 985fa4946b..b2df8664d7 100644 --- a/api/v1/swagger/paths/patrons_holds.yaml +++ b/api/v1/swagger/paths/patrons_holds.yaml @@ -7,14 +7,14 @@ - holds summary: List holds for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/patron_id_pp" + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -23,30 +23,30 @@ schema: type: array items: - $ref: ../definitions.yaml#/hold + $ref: "../swagger.yaml#/definitions/hold" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: edit_borrowers diff --git a/api/v1/swagger/paths/patrons_password.yaml b/api/v1/swagger/paths/patrons_password.yaml index 7636daae0b..2d2f07e08f 100644 --- a/api/v1/swagger/paths/patrons_password.yaml +++ b/api/v1/swagger/paths/patrons_password.yaml @@ -7,7 +7,7 @@ - patrons summary: Set password for a patron parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON object containing password information @@ -32,30 +32,30 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: borrowers: "1" diff --git a/api/v1/swagger/paths/public_patrons.yaml b/api/v1/swagger/paths/public_patrons.yaml index f3a6d0f375..2f92f6751b 100644 --- a/api/v1/swagger/paths/public_patrons.yaml +++ b/api/v1/swagger/paths/public_patrons.yaml @@ -7,7 +7,7 @@ - patrons summary: Set password for a patron (public) parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A JSON object containing password information @@ -36,30 +36,30 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: allow-owner: true "/public/patrons/{patron_id}/guarantors/can_see_charges": @@ -70,7 +70,7 @@ - patrons summary: Set if guarantors can see charges (public) parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A boolean representing if guarantors should be able to see the @@ -90,30 +90,30 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: allow-owner: true "/public/patrons/{patron_id}/guarantors/can_see_checkouts": @@ -124,7 +124,7 @@ - patrons summary: Set if guarantors can see checkouts parameters: - - $ref: ../parameters.yaml#/patron_id_pp + - $ref: "../swagger.yaml#/parameters/patron_id_pp" - name: body in: body description: A boolean representing if guarantors should be able to see the @@ -144,29 +144,29 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Patron not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: allow-owner: true diff --git a/api/v1/swagger/paths/quotes.yaml b/api/v1/swagger/paths/quotes.yaml index 18d791dd63..15ea79eebf 100644 --- a/api/v1/swagger/paths/quotes.yaml +++ b/api/v1/swagger/paths/quotes.yaml @@ -29,35 +29,35 @@ description: Case Insensative search on last displayed date required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" responses: "200": description: A list of quotes schema: type: array items: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -73,33 +73,33 @@ description: A JSON object containing informations about the new quote required: true schema: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" produces: - application/json responses: "201": description: Quote added schema: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: edit_quotes @@ -111,29 +111,29 @@ - quotes summary: Get quote parameters: - - $ref: ../parameters.yaml#/quote_id_pp + - $ref: "../swagger.yaml#/parameters/quote_id_pp" produces: - application/json responses: "200": description: A Quote schema: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" "404": description: Quote not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: catalogue: "1" @@ -144,43 +144,43 @@ - quotes summary: Update quote parameters: - - $ref: ../parameters.yaml#/quote_id_pp + - $ref: "../swagger.yaml#/parameters/quote_id_pp" - name: body in: body description: a quote object required: true schema: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" produces: - application/json responses: "200": description: A quote schema: - $ref: ../definitions.yaml#/quote + $ref: "../swagger.yaml#/definitions/quote" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Quote not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: edit_quotes @@ -191,7 +191,7 @@ - quotes summary: Delete quote parameters: - - $ref: ../parameters.yaml#/quote_id_pp + - $ref: "../swagger.yaml#/parameters/quote_id_pp" produces: - application/json responses: @@ -200,26 +200,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Quote not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: tools: edit_quotes diff --git a/api/v1/swagger/paths/return_claims.yaml b/api/v1/swagger/paths/return_claims.yaml index 8c740594dc..a83d2c43f3 100644 --- a/api/v1/swagger/paths/return_claims.yaml +++ b/api/v1/swagger/paths/return_claims.yaml @@ -34,38 +34,38 @@ "201": description: Created claim schema: - $ref: ../definitions.yaml#/return_claim + $ref: "../swagger.yaml#/definitions/return_claim" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Checkout not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict creating the resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -102,34 +102,34 @@ "200": description: Claim notes updated schema: - $ref: ../definitions.yaml#/return_claim + $ref: "../swagger.yaml#/definitions/return_claim" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Claim not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -152,34 +152,34 @@ "204": description: Claim deleted schema: - $ref: ../definitions.yaml#/return_claim + $ref: "../swagger.yaml#/definitions/return_claim" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Claim not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -219,34 +219,34 @@ "200": description: Claim resolved schema: - $ref: ../definitions.yaml#/return_claim + $ref: "../swagger.yaml#/definitions/return_claim" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Claim not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: circulate: circulate_remaining_permissions diff --git a/api/v1/swagger/paths/rotas.yaml b/api/v1/swagger/paths/rotas.yaml index 04ab57b8b0..96eef74830 100644 --- a/api/v1/swagger/paths/rotas.yaml +++ b/api/v1/swagger/paths/rotas.yaml @@ -31,30 +31,30 @@ "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Position not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: stockrotation: "1" diff --git a/api/v1/swagger/paths/suggestions.yaml b/api/v1/swagger/paths/suggestions.yaml index 8c18954fd5..346598e121 100644 --- a/api/v1/swagger/paths/suggestions.yaml +++ b/api/v1/swagger/paths/suggestions.yaml @@ -8,13 +8,13 @@ tags: - suggestions parameters: - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -23,22 +23,22 @@ schema: type: array items: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: suggestions: suggestions_manage @@ -55,33 +55,33 @@ description: A JSON object containing informations about the new suggestion required: true schema: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" produces: - application/json responses: "201": description: Suggestion added schema: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: suggestions: suggestions_manage @@ -94,33 +94,33 @@ tags: - suggestions parameters: - - $ref: ../parameters.yaml#/suggestion_id_pp + - $ref: "../swagger.yaml#/parameters/suggestion_id_pp" produces: - application/json responses: "200": description: A suggestion schema: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Suggestion not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: suggestions: suggestions_manage @@ -132,43 +132,43 @@ tags: - suggestions parameters: - - $ref: ../parameters.yaml#/suggestion_id_pp + - $ref: "../swagger.yaml#/parameters/suggestion_id_pp" - name: body in: body description: A JSON object containing informations about the new hold required: true schema: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" produces: - application/json responses: "200": description: A suggestion schema: - $ref: ../definitions.yaml#/suggestion + $ref: "../swagger.yaml#/definitions/suggestion" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Suggestion not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: suggestions: suggestions_manage @@ -180,7 +180,7 @@ tags: - suggestions parameters: - - $ref: ../parameters.yaml#/suggestion_id_pp + - $ref: "../swagger.yaml#/parameters/suggestion_id_pp" produces: - application/json responses: @@ -191,26 +191,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Suggestion not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: suggestions: suggestions_manage diff --git a/api/v1/swagger/paths/transfer_limits.yaml b/api/v1/swagger/paths/transfer_limits.yaml index dd35f19a7d..f34a423841 100644 --- a/api/v1/swagger/paths/transfer_limits.yaml +++ b/api/v1/swagger/paths/transfer_limits.yaml @@ -27,13 +27,13 @@ description: Search on collection_code required: false type: string - - $ref: ../parameters.yaml#/match - - $ref: ../parameters.yaml#/order_by - - $ref: ../parameters.yaml#/page - - $ref: ../parameters.yaml#/per_page - - $ref: ../parameters.yaml#/q_param - - $ref: ../parameters.yaml#/q_body - - $ref: ../parameters.yaml#/q_header + - $ref: "../swagger.yaml#/parameters/match" + - $ref: "../swagger.yaml#/parameters/order_by" + - $ref: "../swagger.yaml#/parameters/page" + - $ref: "../swagger.yaml#/parameters/per_page" + - $ref: "../swagger.yaml#/parameters/q_param" + - $ref: "../swagger.yaml#/parameters/q_body" + - $ref: "../swagger.yaml#/parameters/q_header" produces: - application/json responses: @@ -42,18 +42,18 @@ schema: type: array items: - $ref: ../definitions.yaml#/transfer_limit + $ref: "../swagger.yaml#/definitions/transfer_limit" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_transfers @@ -71,41 +71,41 @@ description: A JSON object containing information about a new transfer limit required: true schema: - $ref: ../definitions.yaml#/transfer_limit + $ref: "../swagger.yaml#/definitions/transfer_limit" produces: - application/json responses: "201": description: Transfer limit added schema: - $ref: ../definitions.yaml#/transfer_limit + $ref: "../swagger.yaml#/definitions/transfer_limit" "400": description: Bad request schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "409": description: Conflict in creating resource schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_transfers @@ -118,7 +118,7 @@ - transfer summary: Delete transfer limit parameters: - - $ref: ../parameters.yaml#/transfer_limit_id_pp + - $ref: "../swagger.yaml#/parameters/transfer_limit_id_pp" produces: - application/json responses: @@ -129,26 +129,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_transfers @@ -230,18 +230,18 @@ schema: type: array items: - $ref: ../definitions.yaml#/transfer_limit + $ref: "../swagger.yaml#/definitions/transfer_limit" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_transfers @@ -290,26 +290,26 @@ "401": description: Authentication required schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "403": description: Access forbidden schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "404": description: Library not found schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "500": description: | Internal server error. Possible `error_code` attribute values: * `internal_server_error` schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" "503": description: Under maintenance schema: - $ref: ../definitions.yaml#/error + $ref: "../swagger.yaml#/definitions/error" x-koha-authorization: permissions: parameters: manage_transfers diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index a25b3e3f77..9083efc3e5 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -3,210 +3,390 @@ swagger: 2.0 basePath: /api/v1 definitions: account_line: - $ref: definitions/account_line.yaml + $ref: ./definitions/account_line.yaml advancededitormacro: - $ref: definitions/advancededitormacro.yaml + $ref: ./definitions/advancededitormacro.yaml allows_renewal: - $ref: definitions/allows_renewal.yaml + $ref: ./definitions/allows_renewal.yaml basket: - $ref: definitions/basket.yaml + $ref: ./definitions/basket.yaml cashup: - $ref: definitions/cashup.yaml + $ref: ./definitions/cashup.yaml checkout: - $ref: definitions/checkout.yaml + $ref: ./definitions/checkout.yaml checkouts: - $ref: definitions/checkouts.yaml + $ref: ./definitions/checkouts.yaml circ-rule-kind: - $ref: definitions/circ-rule-kind.yaml + $ref: ./definitions/circ-rule-kind.yaml city: - $ref: definitions/city.yaml + $ref: ./definitions/city.yaml error: - $ref: definitions/error.yaml + $ref: ./definitions/error.yaml fund: - $ref: definitions/fund.yaml + $ref: ./definitions/fund.yaml hold: - $ref: definitions/hold.yaml + $ref: ./definitions/hold.yaml holds: - $ref: definitions/holds.yaml + $ref: ./definitions/holds.yaml ill_backend: - $ref: definitions/ill_backend.yaml + $ref: ./definitions/ill_backend.yaml ill_backends: - $ref: definitions/ill_backends.yaml + $ref: ./definitions/ill_backends.yaml import_batch_profile: - $ref: definitions/import_batch_profile.yaml + $ref: ./definitions/import_batch_profile.yaml import_batch_profiles: - $ref: definitions/import_batch_profiles.yaml + $ref: ./definitions/import_batch_profiles.yaml invoice: - $ref: definitions/invoice.yaml + $ref: ./definitions/invoice.yaml item: - $ref: definitions/item.yaml + $ref: ./definitions/item.yaml library: - $ref: definitions/library.yaml + $ref: ./definitions/library.yaml order: - $ref: definitions/order.yaml + $ref: ./definitions/order.yaml patron: - $ref: definitions/patron.yaml + $ref: ./definitions/patron.yaml patron_account_credit: - $ref: definitions/patron_account_credit.yaml + $ref: ./definitions/patron_account_credit.yaml patron_balance: - $ref: definitions/patron_balance.yaml + $ref: ./definitions/patron_balance.yaml patron_extended_attribute: - $ref: definitions/patron_extended_attribute.yaml + $ref: ./definitions/patron_extended_attribute.yaml quote: - $ref: definitions/quote.yaml + $ref: ./definitions/quote.yaml return_claim: - $ref: definitions/return_claim.yaml + $ref: ./definitions/return_claim.yaml smtp_server: - $ref: definitions/smtp_server.yaml + $ref: ./definitions/smtp_server.yaml suggestion: - $ref: definitions/suggestion.yaml + $ref: ./definitions/suggestion.yaml transfer_limit: - $ref: definitions/transfer_limit.yaml + $ref: ./definitions/transfer_limit.yaml vendor: - $ref: definitions/vendor.yaml + $ref: ./definitions/vendor.yaml paths: /acquisitions/funds: - $ref: paths/acquisitions_funds.yaml#/~1acquisitions~1funds + $ref: ./paths/acquisitions_funds.yaml#/~1acquisitions~1funds /acquisitions/orders: - $ref: paths/acquisitions_orders.yaml#/~1acquisitions~1orders + $ref: ./paths/acquisitions_orders.yaml#/~1acquisitions~1orders "/acquisitions/orders/{order_id}": - $ref: "paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}" + $ref: "./paths/acquisitions_orders.yaml#/~1acquisitions~1orders~1{order_id}" /acquisitions/vendors: - $ref: paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors + $ref: ./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors "/acquisitions/vendors/{vendor_id}": - $ref: "paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}" + $ref: "./paths/acquisitions_vendors.yaml#/~1acquisitions~1vendors~1{vendor_id}" /advanced_editor/macros: - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros + $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros /advanced_editor/macros/shared: - $ref: paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared + $ref: ./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared "/advanced_editor/macros/shared/{advancededitormacro_id}": - $ref: "paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}" + $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1shared~1{advancededitormacro_id}" "/advanced_editor/macros/{advancededitormacro_id}": - $ref: "paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}" + $ref: "./paths/advancededitormacros.yaml#/~1advanced_editor~1macros~1{advancededitormacro_id}" "/article_requests/{article_request_id}": - $ref: "paths/article_requests.yaml#/~1article_requests~1{article_request_id}" + $ref: "./paths/article_requests.yaml#/~1article_requests~1{article_request_id}" "/biblios/{biblio_id}": - $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}" + $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}" "/biblios/{biblio_id}/checkouts": - $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts" + $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1checkouts" "/biblios/{biblio_id}/items": - $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1items" + $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1items" "/biblios/{biblio_id}/pickup_locations": - $ref: "paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations" + $ref: "./paths/biblios.yaml#/~1biblios~1{biblio_id}~1pickup_locations" "/cash_registers/{cash_register_id}/cashups": - $ref: "paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups" + $ref: "./paths/cash_registers.yaml#/~1cash_registers~1{cash_register_id}~1cashups" "/cashups/{cashup_id}": - $ref: "paths/cash_registers.yaml#/~1cashups~1{cashup_id}" + $ref: "./paths/cash_registers.yaml#/~1cashups~1{cashup_id}" /checkouts: - $ref: paths/checkouts.yaml#/~1checkouts + $ref: ./paths/checkouts.yaml#/~1checkouts "/checkouts/{checkout_id}": - $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}" + $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}" "/checkouts/{checkout_id}/allows_renewal": - $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal" + $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1allows_renewal" "/checkouts/{checkout_id}/renewal": - $ref: "paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal" + $ref: "./paths/checkouts.yaml#/~1checkouts~1{checkout_id}~1renewal" /circulation-rules/kinds: - $ref: paths/circulation-rules.yaml#/~1circulation-rules~1kinds + $ref: ./paths/circulation-rules.yaml#/~1circulation-rules~1kinds /cities: - $ref: paths/cities.yaml#/~1cities + $ref: ./paths/cities.yaml#/~1cities "/cities/{city_id}": - $ref: "paths/cities.yaml#/~1cities~1{city_id}" + $ref: "./paths/cities.yaml#/~1cities~1{city_id}" "/clubs/{club_id}/holds": - $ref: "paths/clubs.yaml#/~1clubs~1{club_id}~1holds" + $ref: "./paths/clubs.yaml#/~1clubs~1{club_id}~1holds" /config/smtp_servers: - $ref: paths/config_smtp_servers.yaml#/~1config~1smtp_servers + $ref: ./paths/config_smtp_servers.yaml#/~1config~1smtp_servers "/config/smtp_servers/{smtp_server_id}": - $ref: "paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}" + $ref: "./paths/config_smtp_servers.yaml#/~1config~1smtp_servers~1{smtp_server_id}" /holds: - $ref: paths/holds.yaml#/~1holds + $ref: ./paths/holds.yaml#/~1holds "/holds/{hold_id}": - $ref: "paths/holds.yaml#/~1holds~1{hold_id}" + $ref: "./paths/holds.yaml#/~1holds~1{hold_id}" "/holds/{hold_id}/pickup_location": - $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location" + $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_location" "/holds/{hold_id}/pickup_locations": - $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations" + $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1pickup_locations" "/holds/{hold_id}/priority": - $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1priority" + $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1priority" "/holds/{hold_id}/suspension": - $ref: "paths/holds.yaml#/~1holds~1{hold_id}~1suspension" + $ref: "./paths/holds.yaml#/~1holds~1{hold_id}~1suspension" /ill_backends: - $ref: paths/ill_backends.yaml#/~1ill_backends + $ref: ./paths/ill_backends.yaml#/~1ill_backends "/ill_backends/{ill_backend_id}": - $ref: "paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id}" + $ref: "./paths/ill_backends.yaml#/~1ill_backends~1{ill_backend_id}" /illrequests: - $ref: paths/illrequests.yaml#/~1illrequests + $ref: ./paths/illrequests.yaml#/~1illrequests /import_batch_profiles: - $ref: paths/import_batch_profiles.yaml#/~1import_batch_profiles + $ref: ./paths/import_batch_profiles.yaml#/~1import_batch_profiles "/import_batch_profiles/{import_batch_profile_id}": - $ref: "paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}" + $ref: "./paths/import_batch_profiles.yaml#/~1import_batch_profiles~1{import_batch_profile_id}" /items: - $ref: paths/items.yaml#/~1items + $ref: ./paths/items.yaml#/~1items "/items/{item_id}": - $ref: "paths/items.yaml#/~1items~1{item_id}" + $ref: "./paths/items.yaml#/~1items~1{item_id}" "/items/{item_id}/pickup_locations": - $ref: "paths/items.yaml#/~1items~1{item_id}~1pickup_locations" + $ref: "./paths/items.yaml#/~1items~1{item_id}~1pickup_locations" /libraries: - $ref: paths/libraries.yaml#/~1libraries + $ref: ./paths/libraries.yaml#/~1libraries "/libraries/{library_id}": - $ref: "paths/libraries.yaml#/~1libraries~1{library_id}" + $ref: "./paths/libraries.yaml#/~1libraries~1{library_id}" /oauth/token: - $ref: paths/oauth.yaml#/~1oauth~1token + $ref: ./paths/oauth.yaml#/~1oauth~1token /patrons: - $ref: paths/patrons.yaml#/~1patrons + $ref: ./paths/patrons.yaml#/~1patrons "/patrons/{patron_id}": - $ref: "paths/patrons.yaml#/~1patrons~1{patron_id}" + $ref: "./paths/patrons.yaml#/~1patrons~1{patron_id}" "/patrons/{patron_id}/account": - $ref: "paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account" + $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account" "/patrons/{patron_id}/account/credits": - $ref: "paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits" + $ref: "./paths/patrons_account.yaml#/~1patrons~1{patron_id}~1account~1credits" "/patrons/{patron_id}/extended_attributes": - $ref: "paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes" + $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes" "/patrons/{patron_id}/extended_attributes/{extended_attribute_id}": - $ref: "paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}" + $ref: "./paths/patrons_extended_attributes.yaml#/~1patrons~1{patron_id}~1extended_attributes~1{extended_attribute_id}" "/patrons/{patron_id}/holds": - $ref: "paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds" + $ref: "./paths/patrons_holds.yaml#/~1patrons~1{patron_id}~1holds" "/patrons/{patron_id}/password": - $ref: "paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password" + $ref: "./paths/patrons_password.yaml#/~1patrons~1{patron_id}~1password" "/public/biblios/{biblio_id}": - $ref: "paths/biblios.yaml#/~1public~1biblios~1{biblio_id}" + $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}" "/public/biblios/{biblio_id}/items": - $ref: "paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items" + $ref: "./paths/biblios.yaml#/~1public~1biblios~1{biblio_id}~1items" /public/libraries: - $ref: paths/libraries.yaml#/~1public~1libraries + $ref: ./paths/libraries.yaml#/~1public~1libraries "/public/libraries/{library_id}": - $ref: "paths/libraries.yaml#/~1public~1libraries~1{library_id}" + $ref: "./paths/libraries.yaml#/~1public~1libraries~1{library_id}" "/public/patrons/{patron_id}/article_requests/{article_request_id}": - $ref: "paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}" + $ref: "./paths/article_requests.yaml#/~1public~1patrons~1{patron_id}~1article_requests~1{article_request_id}" "/public/patrons/{patron_id}/guarantors/can_see_charges": - $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges" + $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_charges" "/public/patrons/{patron_id}/guarantors/can_see_checkouts": - $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts" + $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1guarantors~1can_see_checkouts" "/public/patrons/{patron_id}/password": - $ref: "paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password" + $ref: "./paths/public_patrons.yaml#/~1public~1patrons~1{patron_id}~1password" /quotes: - $ref: paths/quotes.yaml#/~1quotes + $ref: ./paths/quotes.yaml#/~1quotes "/quotes/{quote_id}": - $ref: "paths/quotes.yaml#/~1quotes~1{quote_id}" + $ref: "./paths/quotes.yaml#/~1quotes~1{quote_id}" /return_claims: - $ref: paths/return_claims.yaml#/~1return_claims + $ref: ./paths/return_claims.yaml#/~1return_claims "/return_claims/{claim_id}": - $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}" + $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}" "/return_claims/{claim_id}/notes": - $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes" + $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1notes" "/return_claims/{claim_id}/resolve": - $ref: "paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve" + $ref: "./paths/return_claims.yaml#/~1return_claims~1{claim_id}~1resolve" "/rotas/{rota_id}/stages/{stage_id}/position": - $ref: "paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position" + $ref: "./paths/rotas.yaml#/~1rotas~1{rota_id}~1stages~1{stage_id}~1position" /suggestions: - $ref: paths/suggestions.yaml#/~1suggestions + $ref: ./paths/suggestions.yaml#/~1suggestions "/suggestions/{suggestion_id}": - $ref: "paths/suggestions.yaml#/~1suggestions~1{suggestion_id}" + $ref: "./paths/suggestions.yaml#/~1suggestions~1{suggestion_id}" /transfer_limits: - $ref: paths/transfer_limits.yaml#/~1transfer_limits + $ref: ./paths/transfer_limits.yaml#/~1transfer_limits /transfer_limits/batch: - $ref: paths/transfer_limits.yaml#/~1transfer_limits~1batch + $ref: ./paths/transfer_limits.yaml#/~1transfer_limits~1batch "/transfer_limits/{limit_id}": - $ref: "paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}" + $ref: "./paths/transfer_limits.yaml#/~1transfer_limits~1{limit_id}" +parameters: + advancededitormacro_id_pp: + description: Advanced editor macro internal identifier + in: path + name: advancededitormacro_id + required: true + type: integer + biblio_id_pp: + description: Record internal identifier + in: path + name: biblio_id + required: true + type: integer + cash_register_id_pp: + description: Cash register internal identifier + in: path + name: cash_register_id + required: true + type: integer + cashup_id_pp: + description: Cashup internal identifier + in: path + name: cashup_id + required: true + type: integer + checkout_id_pp: + description: Internal checkout identifier + in: path + name: checkout_id + required: true + type: integer + city_id_pp: + description: City internal identifier + in: path + name: city_id + required: true + type: integer + club_id_pp: + description: Internal club identifier + in: path + name: club_id + required: true + type: integer + fund_id_pp: + description: Fund id + in: path + name: fund_id + required: true + type: integer + hold_id_pp: + description: Internal hold identifier + in: path + name: hold_id + required: true + type: integer + import_batch_profile_id_pp: + description: Internal profile identifier + in: path + name: import_batch_profile_id + required: true + type: integer + item_id_pp: + description: Internal item identifier + in: path + name: item_id + required: true + type: integer + library_id_pp: + description: Internal library identifier + in: path + name: library_id + required: true + type: string + match: + description: Matching criteria + enum: + - contains + - exact + - starts_with + - ends_with + in: query + name: _match + required: false + type: string + order_by: + collectionFormat: csv + description: Sorting criteria + in: query + items: + type: string + name: _order_by + required: false + type: array + order_id_pp: + description: Internal order identifier + in: path + name: order_id + required: true + type: integer + page: + description: "Page number, for paginated object listing" + in: query + name: _page + required: false + type: integer + patron_id_pp: + description: Internal patron identifier + in: path + name: patron_id + required: true + type: integer + patron_id_qp: + description: Internal patron identifier + in: query + name: patron_id + type: integer + per_page: + description: "Page size, for paginated object listing" + in: query + name: _per_page + required: false + type: integer + q_body: + description: Query filter sent through request"s body + in: body + name: query + required: false + schema: + type: object + q_header: + description: Query filter sent as a request header + in: header + name: x-koha-query + required: false + type: string + q_param: + description: Query filter sent as a request parameter + in: query + name: q + required: false + type: array + items: + type: string + collectionFormat: multi + quote_id_pp: + description: Quote internal identifier + in: path + name: quote_id + required: true + type: integer + seen_pp: + description: Item was seen flag + in: query + name: seen + required: false + type: integer + smtp_server_id_pp: + description: SMTP server internal identifier + in: path + name: smtp_server_id + required: true + type: integer + suggestion_id_pp: + description: Internal suggestion identifier + in: path + name: suggestion_id + required: true + type: integer + transfer_limit_id_pp: + description: Internal transfer limit identifier + in: path + name: limit_id + required: true + type: string + vendor_id_pp: + description: Vendor id + in: path + name: vendor_id + required: true + type: integer info: title: Koha REST API version: 1 @@ -218,75 +398,75 @@ info: url: https://koha-community.org/ description: | ## Introduction - + This API is documented in **OpenAPI format**. - + ## Authentication - + The API supports the following authentication mechanisms - + * HTTP Basic authentication * OAuth2 (client credentials grant) * Cookie-based - + Both _Basic authentication_ and the _OAuth2_ flow, need to be enabled by system preferences. - + ## Errors - + The API uses standard HTTP status codes to indicate the success or failure of the API call. The body of the response will be JSON in the following format: - + ``` { "error": "Current settings prevent the passed due date to be applied", "error_code": "invalid_due_date" } ``` - + Note: Some routes might offer additional attributes in their error responses but that"s subject to change and thus not documented. - + ## Filtering responses - + The API allows for some advanced response filtering using a JSON based query syntax. The query can be added to the requests: - + * as a query parameter `q=` * in the request body * in a special header `x-koha-query` - + For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname matches one of the fields as described in the particular endpoints response object. - + We can refine that with more complex matching clauses by nesting a the clause into the object; `{ "fieldname": { "clause": "value" } }`. - + Available matching clauses include ">", "<", ">=", "<=", "-like", and "-not_like". - + We can filter on multiple fields by adding them to the JSON respresentation. Adding at `HASH` level will result in an "AND" query, whilst combinding them in an `ARRAY` wilth result in an "OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those results with both field1 containing value2 AND field2 containing value2 for example. - + ### Examples - + The following request would return any patron with firstname "Henry" and lastname "Acevedo"; - + `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": "Acevedo", "firstname": "Henry" }"` - + The following request would return any patron whose lastname begins with "Ace"; - + `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": { "-like": "Ace%" }"` - + The following request would return any patron whilse lastname is "Acevedo" OR "Bernardo" - + `curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": [ "Acevedo", "Bernardo" ] }"` - + ## Special headers - + ### x-koha-library - + This optional header should be passed to give your api request a library context; If it is not included in the request, then the request context will default to using your api comsumer"s assigned home library. diff --git a/api/v1/swagger/x-primitives.yaml b/api/v1/swagger/x-primitives.yaml deleted file mode 100644 index 382d69d8cb..0000000000 --- a/api/v1/swagger/x-primitives.yaml +++ /dev/null @@ -1,60 +0,0 @@ ---- -biblio_id: - type: integer - description: Internal biblio identifier -advancededitormacro_id: - type: integer - description: Internal advanced editor macro identifier - readOnly: true -patron_id: - type: integer - description: Internal patron identifier -library_id: - type: string - description: internally assigned library identifier - maxLength: 10 - minLength: 1 -limit_id: - type: integer - description: Internal transfer limit identifier -cardnumber: - type: - - string - - "null" - description: library assigned user identifier -city_id: - type: integer - description: internally assigned city identifier - readOnly: true -email: - type: - - string - - "null" - description: primary email address for patron's primary address -firstname: - type: - - string - - "null" - description: patron's first name -phone: - type: - - string - - "null" - description: primary phone number for patron's primary address -surname: - type: - - string - - "null" - description: patron's last name -vendor_id: - type: integer - description: internally assigned vendor identifier - readOnly: true -fund_id: - type: integer - description: internally assigned fund identifier - readOnly: true -quote_id: - type: integer - description: internally assigned quote identifier - readOnly: true -- 2.20.1