Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/api/v1/swagger/paths
History
Tomas Cohen Arazi b7b6a85de5 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 <tomascohen@theke.io>

Signed-off-by: Andrew Fuerste-Henry <andrew@bywatersolutions.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2022-01-05 13:33:46 -10:00
..
acquisitions_funds.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
acquisitions_orders.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
acquisitions_vendors.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
advancededitormacros.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
article_requests.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
biblios.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
cash_registers.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
checkouts.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
circulation-rules.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
cities.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
clubs.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
config_smtp_servers.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
holds.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
ill_backends.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
illrequests.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
import_batch_profiles.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
items.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
libraries.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
oauth.yaml Bug 29620: Move the OpenAPI spec to YAML format 2021-12-07 12:33:35 -10:00
patrons.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
patrons_account.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
patrons_extended_attributes.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
patrons_holds.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
patrons_password.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
public_patrons.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
quotes.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
return_claims.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
rotas.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
suggestions.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00
transfer_limits.yaml Bug 28020: (follow-up) Add docs about error_code on the API 2022-01-05 13:33:46 -10:00