]> git.koha-community.org Git - koha.git/commit
Bug 28020: (follow-up) Add docs about error_code on the API
authorTomas Cohen Arazi <tomascohen@theke.io>
Mon, 27 Dec 2021 12:51:31 +0000 (09:51 -0300)
committerFridolin Somers <fridolin.somers@biblibre.com>
Wed, 5 Jan 2022 23:33:46 +0000 (13:33 -1000)
commitb7b6a85de591df246e1c11b94e0bffac47f23f78
treef5c7c206753e82ccab77bc7409fe82aea0a38489
parent8dee5083ebb1c72a8f3e848826374dfbc072551f
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>
30 files changed:
api/v1/swagger/paths/acquisitions_funds.yaml
api/v1/swagger/paths/acquisitions_orders.yaml
api/v1/swagger/paths/acquisitions_vendors.yaml
api/v1/swagger/paths/advancededitormacros.yaml
api/v1/swagger/paths/article_requests.yaml
api/v1/swagger/paths/biblios.yaml
api/v1/swagger/paths/cash_registers.yaml
api/v1/swagger/paths/checkouts.yaml
api/v1/swagger/paths/circulation-rules.yaml
api/v1/swagger/paths/cities.yaml
api/v1/swagger/paths/clubs.yaml
api/v1/swagger/paths/config_smtp_servers.yaml
api/v1/swagger/paths/holds.yaml
api/v1/swagger/paths/ill_backends.yaml
api/v1/swagger/paths/illrequests.yaml
api/v1/swagger/paths/import_batch_profiles.yaml
api/v1/swagger/paths/items.yaml
api/v1/swagger/paths/libraries.yaml
api/v1/swagger/paths/patrons.yaml
api/v1/swagger/paths/patrons_account.yaml
api/v1/swagger/paths/patrons_extended_attributes.yaml
api/v1/swagger/paths/patrons_holds.yaml
api/v1/swagger/paths/patrons_password.yaml
api/v1/swagger/paths/public_patrons.yaml
api/v1/swagger/paths/quotes.yaml
api/v1/swagger/paths/return_claims.yaml
api/v1/swagger/paths/rotas.yaml
api/v1/swagger/paths/suggestions.yaml
api/v1/swagger/paths/transfer_limits.yaml
api/v1/swagger/swagger.yaml