From c09592f83bad833b3ed21bfd425fc0236e84d78a Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Mon, 27 Dec 2021 09:51:31 -0300 Subject: [PATCH] Bug 28020: (follow-up) Add docs about error_code on the API This patch intends to be a guide for inserting Markdown documentation for error codes. The idea is that it can be copied and pasted as-is in new routes. And adapted to new error codes. To test: 1. Apply this patch 2. Run: $ npx redoc-cli@0.10.4 bundle --cdn --output index.html \ api/v1/swagger/swagger.yaml => SUCCESS: It builds correctly 3. Open index.tml on your browser 4. Pick a route, and see the 500 status description includes information about the possible `error_code` values. 5. Sign off :-D Signed-off-by: Tomas Cohen Arazi Signed-off-by: Andrew Fuerste-Henry --- api/v1/swagger/paths/acquisitions_funds.yaml | 5 ++- api/v1/swagger/paths/acquisitions_orders.yaml | 25 ++++++++--- .../swagger/paths/acquisitions_vendors.yaml | 25 ++++++++--- .../swagger/paths/advancededitormacros.yaml | 5 ++- api/v1/swagger/paths/article_requests.yaml | 10 ++++- api/v1/swagger/paths/biblios.yaml | 36 ++++++++++++--- api/v1/swagger/paths/cash_registers.yaml | 22 +++++++++ api/v1/swagger/paths/checkouts.yaml | 44 ++++++++++++++++++ api/v1/swagger/paths/circulation-rules.yaml | 9 +++- api/v1/swagger/paths/cities.yaml | 15 +++++-- api/v1/swagger/paths/clubs.yaml | 5 ++- api/v1/swagger/paths/config_smtp_servers.yaml | 25 ++++++++--- api/v1/swagger/paths/holds.yaml | 45 +++++++++++++++---- api/v1/swagger/paths/ill_backends.yaml | 10 ++++- api/v1/swagger/paths/illrequests.yaml | 5 ++- .../swagger/paths/import_batch_profiles.yaml | 20 +++++++-- api/v1/swagger/paths/items.yaml | 15 +++++-- api/v1/swagger/paths/libraries.yaml | 30 ++++++++++--- api/v1/swagger/paths/patrons.yaml | 39 ++++++++++++++-- api/v1/swagger/paths/patrons_account.yaml | 10 ++++- .../paths/patrons_extended_attributes.yaml | 25 ++++++++--- api/v1/swagger/paths/patrons_holds.yaml | 5 ++- api/v1/swagger/paths/patrons_password.yaml | 5 ++- api/v1/swagger/paths/public_patrons.yaml | 15 +++++-- api/v1/swagger/paths/quotes.yaml | 25 ++++++++--- api/v1/swagger/paths/return_claims.yaml | 20 +++++++-- api/v1/swagger/paths/rotas.yaml | 5 ++- api/v1/swagger/paths/suggestions.yaml | 25 ++++++++--- api/v1/swagger/paths/transfer_limits.yaml | 25 ++++++++--- api/v1/swagger/swagger.yaml | 3 +- 30 files changed, 462 insertions(+), 91 deletions(-) diff --git a/api/v1/swagger/paths/acquisitions_funds.yaml b/api/v1/swagger/paths/acquisitions_funds.yaml index 92e8e0121a..c0bb41e20f 100644 --- a/api/v1/swagger/paths/acquisitions_funds.yaml +++ b/api/v1/swagger/paths/acquisitions_funds.yaml @@ -46,7 +46,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/acquisitions_orders.yaml b/api/v1/swagger/paths/acquisitions_orders.yaml index 5f4f7033c2..717ca7a7ba 100644 --- a/api/v1/swagger/paths/acquisitions_orders.yaml +++ b/api/v1/swagger/paths/acquisitions_orders.yaml @@ -62,7 +62,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -125,7 +128,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -164,7 +170,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -222,7 +231,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -258,7 +270,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/acquisitions_vendors.yaml b/api/v1/swagger/paths/acquisitions_vendors.yaml index 65fd2b2463..1d816d6364 100644 --- a/api/v1/swagger/paths/acquisitions_vendors.yaml +++ b/api/v1/swagger/paths/acquisitions_vendors.yaml @@ -46,7 +46,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -89,7 +92,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -128,7 +134,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -172,7 +181,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -208,7 +220,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/advancededitormacros.yaml b/api/v1/swagger/paths/advancededitormacros.yaml index d85d3147ae..8fdbd9ef93 100644 --- a/api/v1/swagger/paths/advancededitormacros.yaml +++ b/api/v1/swagger/paths/advancededitormacros.yaml @@ -48,7 +48,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/article_requests.yaml b/api/v1/swagger/paths/article_requests.yaml index 1b3c2df793..2b472cecbf 100644 --- a/api/v1/swagger/paths/article_requests.yaml +++ b/api/v1/swagger/paths/article_requests.yaml @@ -44,7 +44,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -100,7 +103,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/biblios.yaml b/api/v1/swagger/paths/biblios.yaml index 7c64399ecb..c48873fb90 100644 --- a/api/v1/swagger/paths/biblios.yaml +++ b/api/v1/swagger/paths/biblios.yaml @@ -37,7 +37,10 @@ items: type: string "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -125,6 +128,17 @@ description: Biblio not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/error x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -180,7 +194,10 @@ items: type: string "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -239,7 +256,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -286,7 +306,10 @@ items: type: string "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -340,7 +363,10 @@ items: type: string "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/cash_registers.yaml b/api/v1/swagger/paths/cash_registers.yaml index 9abbac3110..fb3b27a5c1 100644 --- a/api/v1/swagger/paths/cash_registers.yaml +++ b/api/v1/swagger/paths/cash_registers.yaml @@ -32,6 +32,17 @@ description: Register not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/error x-koha-authorization: permissions: cash_management: cashup @@ -61,6 +72,17 @@ description: Patron not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/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 8e46314430..c90204fdb4 100644 --- a/api/v1/swagger/paths/checkouts.yaml +++ b/api/v1/swagger/paths/checkouts.yaml @@ -35,6 +35,17 @@ description: Patron not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/error x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -64,6 +75,17 @@ description: Checkout not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/error x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -94,6 +116,17 @@ description: Checkout not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/error x-koha-authorization: permissions: circulate: circulate_remaining_permissions @@ -121,6 +154,17 @@ description: Checkout not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/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 f1b0dadb55..eaee8ee9fe 100644 --- a/api/v1/swagger/paths/circulation-rules.yaml +++ b/api/v1/swagger/paths/circulation-rules.yaml @@ -20,6 +20,13 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance schema: $ref: ../definitions.yaml#/error diff --git a/api/v1/swagger/paths/cities.yaml b/api/v1/swagger/paths/cities.yaml index 4719aa9720..15bbf8a28b 100644 --- a/api/v1/swagger/paths/cities.yaml +++ b/api/v1/swagger/paths/cities.yaml @@ -48,7 +48,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -87,7 +90,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -118,7 +124,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/clubs.yaml b/api/v1/swagger/paths/clubs.yaml index 8c21220307..c47574c3eb 100644 --- a/api/v1/swagger/paths/clubs.yaml +++ b/api/v1/swagger/paths/clubs.yaml @@ -81,7 +81,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/config_smtp_servers.yaml b/api/v1/swagger/paths/config_smtp_servers.yaml index 1da388ffba..f2cfd7354a 100644 --- a/api/v1/swagger/paths/config_smtp_servers.yaml +++ b/api/v1/swagger/paths/config_smtp_servers.yaml @@ -28,7 +28,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -71,7 +74,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -106,7 +112,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -150,7 +159,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -186,7 +198,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/holds.yaml b/api/v1/swagger/paths/holds.yaml index 4516c06ad0..ea778c1a90 100644 --- a/api/v1/swagger/paths/holds.yaml +++ b/api/v1/swagger/paths/holds.yaml @@ -104,7 +104,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -206,7 +209,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -270,7 +276,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -335,7 +344,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -371,7 +383,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -420,7 +435,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -475,7 +493,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -517,7 +538,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -574,7 +598,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/ill_backends.yaml b/api/v1/swagger/paths/ill_backends.yaml index ea15087182..cbd6377313 100644 --- a/api/v1/swagger/paths/ill_backends.yaml +++ b/api/v1/swagger/paths/ill_backends.yaml @@ -27,7 +27,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -70,7 +73,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/illrequests.yaml b/api/v1/swagger/paths/illrequests.yaml index d213f370bf..38bc2091d5 100644 --- a/api/v1/swagger/paths/illrequests.yaml +++ b/api/v1/swagger/paths/illrequests.yaml @@ -116,7 +116,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/import_batch_profiles.yaml b/api/v1/swagger/paths/import_batch_profiles.yaml index 066d073a3c..da2caa54b9 100644 --- a/api/v1/swagger/paths/import_batch_profiles.yaml +++ b/api/v1/swagger/paths/import_batch_profiles.yaml @@ -37,7 +37,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -141,7 +144,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -247,7 +253,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -283,7 +292,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/items.yaml b/api/v1/swagger/paths/items.yaml index 0ebae8bc38..bbd391e51e 100644 --- a/api/v1/swagger/paths/items.yaml +++ b/api/v1/swagger/paths/items.yaml @@ -39,7 +39,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -76,7 +79,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -135,7 +141,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/libraries.yaml b/api/v1/swagger/paths/libraries.yaml index 8d516fd937..db80d14178 100644 --- a/api/v1/swagger/paths/libraries.yaml +++ b/api/v1/swagger/paths/libraries.yaml @@ -109,7 +109,10 @@ items: $ref: ../definitions.yaml#/library "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -158,7 +161,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -233,7 +239,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -271,7 +280,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -306,7 +318,10 @@ items: $ref: ../definitions.yaml#/library "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -347,7 +362,10 @@ items: type: string "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/patrons.yaml b/api/v1/swagger/paths/patrons.yaml index 2341df8dba..5d3df19c9d 100644 --- a/api/v1/swagger/paths/patrons.yaml +++ b/api/v1/swagger/paths/patrons.yaml @@ -367,7 +367,14 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance schema: $ref: ../definitions.yaml#/error x-koha-authorization: @@ -419,7 +426,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -458,7 +468,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -511,7 +524,14 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance schema: $ref: ../definitions.yaml#/error x-koha-authorization: @@ -546,6 +566,17 @@ description: Patron not found schema: $ref: ../definitions.yaml#/error + "500": + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` + schema: + $ref: ../definitions.yaml#/error + "503": + description: Under maintenance + schema: + $ref: ../definitions.yaml#/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 bf93b443c3..90043d9494 100644 --- a/api/v1/swagger/paths/patrons_account.yaml +++ b/api/v1/swagger/paths/patrons_account.yaml @@ -28,7 +28,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -74,7 +77,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/patrons_extended_attributes.yaml b/api/v1/swagger/paths/patrons_extended_attributes.yaml index 6d2cadf8e4..ecaf2c6678 100644 --- a/api/v1/swagger/paths/patrons_extended_attributes.yaml +++ b/api/v1/swagger/paths/patrons_extended_attributes.yaml @@ -37,7 +37,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -89,7 +92,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -145,7 +151,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -209,7 +218,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -250,7 +262,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/patrons_holds.yaml b/api/v1/swagger/paths/patrons_holds.yaml index f406785f0f..985fa4946b 100644 --- a/api/v1/swagger/paths/patrons_holds.yaml +++ b/api/v1/swagger/paths/patrons_holds.yaml @@ -37,7 +37,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/patrons_password.yaml b/api/v1/swagger/paths/patrons_password.yaml index 3ddf39aae9..7636daae0b 100644 --- a/api/v1/swagger/paths/patrons_password.yaml +++ b/api/v1/swagger/paths/patrons_password.yaml @@ -46,7 +46,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/public_patrons.yaml b/api/v1/swagger/paths/public_patrons.yaml index 6ecd4f8657..f3a6d0f375 100644 --- a/api/v1/swagger/paths/public_patrons.yaml +++ b/api/v1/swagger/paths/public_patrons.yaml @@ -50,7 +50,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -101,7 +104,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -152,7 +158,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/quotes.yaml b/api/v1/swagger/paths/quotes.yaml index 4ddb3de4ae..18d791dd63 100644 --- a/api/v1/swagger/paths/quotes.yaml +++ b/api/v1/swagger/paths/quotes.yaml @@ -48,7 +48,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -87,7 +90,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -118,7 +124,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -162,7 +171,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -198,7 +210,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/return_claims.yaml b/api/v1/swagger/paths/return_claims.yaml index 82b98b9605..8c740594dc 100644 --- a/api/v1/swagger/paths/return_claims.yaml +++ b/api/v1/swagger/paths/return_claims.yaml @@ -56,7 +56,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -117,7 +120,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -164,7 +170,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -228,7 +237,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/rotas.yaml b/api/v1/swagger/paths/rotas.yaml index f78234e8fe..04ab57b8b0 100644 --- a/api/v1/swagger/paths/rotas.yaml +++ b/api/v1/swagger/paths/rotas.yaml @@ -45,7 +45,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal server error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/suggestions.yaml b/api/v1/swagger/paths/suggestions.yaml index e14ddb78ab..8c18954fd5 100644 --- a/api/v1/swagger/paths/suggestions.yaml +++ b/api/v1/swagger/paths/suggestions.yaml @@ -29,7 +29,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -69,7 +72,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -105,7 +111,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -150,7 +159,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -189,7 +201,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/paths/transfer_limits.yaml b/api/v1/swagger/paths/transfer_limits.yaml index 26747810fb..dd35f19a7d 100644 --- a/api/v1/swagger/paths/transfer_limits.yaml +++ b/api/v1/swagger/paths/transfer_limits.yaml @@ -44,7 +44,10 @@ items: $ref: ../definitions.yaml#/transfer_limit "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -93,7 +96,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -133,7 +139,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -223,7 +232,10 @@ items: $ref: ../definitions.yaml#/transfer_limit "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": @@ -288,7 +300,10 @@ schema: $ref: ../definitions.yaml#/error "500": - description: Internal error + description: | + Internal server error. Possible `error_code` attribute values: + + * `internal_server_error` schema: $ref: ../definitions.yaml#/error "503": diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index f9fb8768b6..63597829f6 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -41,7 +41,8 @@ info: ``` { - "error": "patron not found" + "error": "Current settings prevent the passed due date to be applied", + "error_code": "invalid_due_date" } ``` -- 2.20.1