Bug 29620: Move the OpenAPI spec to YAML format
authorTomas Cohen Arazi <tomascohen@theke.io>
Thu, 2 Dec 2021 12:08:48 +0000 (09:08 -0300)
committerKyle Hall <kyle@bywatersolutions.com>
Fri, 10 Dec 2021 12:29:02 +0000 (07:29 -0500)
commit46d19dd6176df12410bbc4aa17508174a2935ef8
treea2039322e0845ec13849a21e505d32554cc2d740
parent6c52b366c36cebcf1ab70da63c9513f01dc766e9
Bug 29620: Move the OpenAPI spec to YAML format

This patch moves all the REST API spec pieces into YAML.

To test:
1. Run:
   $ kshell
  k$ prove t/db_dependent/api/v1/*
=> SUCCESS: Tests pass
2. Apply this patch
3. Repeat 1
=> SUCCESS: Tests still pass!
4. Sign off :-D

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
167 files changed:
api/v1/swagger/definitions.json [deleted file]
api/v1/swagger/definitions.yaml [new file with mode: 0644]
api/v1/swagger/definitions/account_line.json [deleted file]
api/v1/swagger/definitions/account_line.yaml [new file with mode: 0644]
api/v1/swagger/definitions/advancededitormacro.json [deleted file]
api/v1/swagger/definitions/advancededitormacro.yaml [new file with mode: 0644]
api/v1/swagger/definitions/allows_renewal.json [deleted file]
api/v1/swagger/definitions/allows_renewal.yaml [new file with mode: 0644]
api/v1/swagger/definitions/basket.json [deleted file]
api/v1/swagger/definitions/basket.yaml [new file with mode: 0644]
api/v1/swagger/definitions/cashup.json [deleted file]
api/v1/swagger/definitions/cashup.yaml [new file with mode: 0644]
api/v1/swagger/definitions/checkout.json [deleted file]
api/v1/swagger/definitions/checkout.yaml [new file with mode: 0644]
api/v1/swagger/definitions/checkouts.json [deleted file]
api/v1/swagger/definitions/checkouts.yaml [new file with mode: 0644]
api/v1/swagger/definitions/circ-rule-kind.json [deleted file]
api/v1/swagger/definitions/circ-rule-kind.yaml [new file with mode: 0644]
api/v1/swagger/definitions/city.yaml
api/v1/swagger/definitions/club_hold.json [deleted file]
api/v1/swagger/definitions/club_hold.yaml [new file with mode: 0644]
api/v1/swagger/definitions/club_hold_patron_hold.json [deleted file]
api/v1/swagger/definitions/club_hold_patron_hold.yaml [new file with mode: 0644]
api/v1/swagger/definitions/club_hold_patron_holds.json [deleted file]
api/v1/swagger/definitions/club_hold_patron_holds.yaml [new file with mode: 0644]
api/v1/swagger/definitions/club_holds.json [deleted file]
api/v1/swagger/definitions/club_holds.yaml [new file with mode: 0644]
api/v1/swagger/definitions/error.json [deleted file]
api/v1/swagger/definitions/error.yaml [new file with mode: 0644]
api/v1/swagger/definitions/fund.json [deleted file]
api/v1/swagger/definitions/fund.yaml [new file with mode: 0644]
api/v1/swagger/definitions/hold.json [deleted file]
api/v1/swagger/definitions/hold.yaml [new file with mode: 0644]
api/v1/swagger/definitions/holds.json [deleted file]
api/v1/swagger/definitions/holds.yaml [new file with mode: 0644]
api/v1/swagger/definitions/ill_backend.json [deleted file]
api/v1/swagger/definitions/ill_backend.yaml [new file with mode: 0644]
api/v1/swagger/definitions/ill_backends.json [deleted file]
api/v1/swagger/definitions/ill_backends.yaml [new file with mode: 0644]
api/v1/swagger/definitions/import_batch_profile.json [deleted file]
api/v1/swagger/definitions/import_batch_profile.yaml [new file with mode: 0644]
api/v1/swagger/definitions/import_batch_profiles.json [deleted file]
api/v1/swagger/definitions/import_batch_profiles.yaml [new file with mode: 0644]
api/v1/swagger/definitions/invoice.json [deleted file]
api/v1/swagger/definitions/invoice.yaml [new file with mode: 0644]
api/v1/swagger/definitions/library.json [deleted file]
api/v1/swagger/definitions/library.yaml [new file with mode: 0644]
api/v1/swagger/definitions/order.json [deleted file]
api/v1/swagger/definitions/order.yaml [new file with mode: 0644]
api/v1/swagger/definitions/patron.json [deleted file]
api/v1/swagger/definitions/patron.yaml [new file with mode: 0644]
api/v1/swagger/definitions/patron_account_credit.json [deleted file]
api/v1/swagger/definitions/patron_account_credit.yaml [new file with mode: 0644]
api/v1/swagger/definitions/patron_balance.json [deleted file]
api/v1/swagger/definitions/patron_balance.yaml [new file with mode: 0644]
api/v1/swagger/definitions/patron_extended_attribute.json [deleted file]
api/v1/swagger/definitions/patron_extended_attribute.yaml [new file with mode: 0644]
api/v1/swagger/definitions/quote.json [deleted file]
api/v1/swagger/definitions/quote.yaml [new file with mode: 0644]
api/v1/swagger/definitions/return_claim.json [deleted file]
api/v1/swagger/definitions/return_claim.yaml [new file with mode: 0644]
api/v1/swagger/definitions/smtp_server.json [deleted file]
api/v1/swagger/definitions/smtp_server.yaml [new file with mode: 0644]
api/v1/swagger/definitions/transfer_limit.json [deleted file]
api/v1/swagger/definitions/transfer_limit.yaml [new file with mode: 0644]
api/v1/swagger/definitions/vendor.json [deleted file]
api/v1/swagger/definitions/vendor.yaml [new file with mode: 0644]
api/v1/swagger/parameters.json [deleted file]
api/v1/swagger/parameters.yaml [new file with mode: 0644]
api/v1/swagger/parameters/advancededitormacro.json [deleted file]
api/v1/swagger/parameters/advancededitormacro.yaml [new file with mode: 0644]
api/v1/swagger/parameters/biblio.json [deleted file]
api/v1/swagger/parameters/biblio.yaml [new file with mode: 0644]
api/v1/swagger/parameters/cash_register.json [deleted file]
api/v1/swagger/parameters/cash_register.yaml [new file with mode: 0644]
api/v1/swagger/parameters/cashup.json [deleted file]
api/v1/swagger/parameters/cashup.yaml [new file with mode: 0644]
api/v1/swagger/parameters/checkout.json [deleted file]
api/v1/swagger/parameters/checkout.yaml [new file with mode: 0644]
api/v1/swagger/parameters/city.json [deleted file]
api/v1/swagger/parameters/city.yaml [new file with mode: 0644]
api/v1/swagger/parameters/club.json [deleted file]
api/v1/swagger/parameters/club.yaml [new file with mode: 0644]
api/v1/swagger/parameters/fund.json [deleted file]
api/v1/swagger/parameters/fund.yaml [new file with mode: 0644]
api/v1/swagger/parameters/hold.json [deleted file]
api/v1/swagger/parameters/hold.yaml [new file with mode: 0644]
api/v1/swagger/parameters/import_batch_profile.json [deleted file]
api/v1/swagger/parameters/import_batch_profile.yaml [new file with mode: 0644]
api/v1/swagger/parameters/item.json [deleted file]
api/v1/swagger/parameters/item.yaml [new file with mode: 0644]
api/v1/swagger/parameters/library.json [deleted file]
api/v1/swagger/parameters/library.yaml [new file with mode: 0644]
api/v1/swagger/parameters/order.json [deleted file]
api/v1/swagger/parameters/order.yaml [new file with mode: 0644]
api/v1/swagger/parameters/patron.json [deleted file]
api/v1/swagger/parameters/patron.yaml [new file with mode: 0644]
api/v1/swagger/parameters/quote.json [deleted file]
api/v1/swagger/parameters/quote.yaml [new file with mode: 0644]
api/v1/swagger/parameters/smtp_server.json [deleted file]
api/v1/swagger/parameters/smtp_server.yaml [new file with mode: 0644]
api/v1/swagger/parameters/suggestion.json [deleted file]
api/v1/swagger/parameters/suggestion.yaml [new file with mode: 0644]
api/v1/swagger/parameters/transfer_limit.json [deleted file]
api/v1/swagger/parameters/transfer_limit.yaml [new file with mode: 0644]
api/v1/swagger/parameters/vendor.json [deleted file]
api/v1/swagger/parameters/vendor.yaml [new file with mode: 0644]
api/v1/swagger/paths.json [deleted file]
api/v1/swagger/paths.yaml [new file with mode: 0644]
api/v1/swagger/paths/acquisitions_funds.json [deleted file]
api/v1/swagger/paths/acquisitions_funds.yaml [new file with mode: 0644]
api/v1/swagger/paths/acquisitions_orders.json [deleted file]
api/v1/swagger/paths/acquisitions_orders.yaml [new file with mode: 0644]
api/v1/swagger/paths/acquisitions_vendors.json [deleted file]
api/v1/swagger/paths/acquisitions_vendors.yaml [new file with mode: 0644]
api/v1/swagger/paths/advancededitormacros.json [deleted file]
api/v1/swagger/paths/advancededitormacros.yaml [new file with mode: 0644]
api/v1/swagger/paths/article_requests.yaml
api/v1/swagger/paths/biblios.json [deleted file]
api/v1/swagger/paths/biblios.yaml [new file with mode: 0644]
api/v1/swagger/paths/cash_registers.json [deleted file]
api/v1/swagger/paths/cash_registers.yaml [new file with mode: 0644]
api/v1/swagger/paths/checkouts.json [deleted file]
api/v1/swagger/paths/checkouts.yaml [new file with mode: 0644]
api/v1/swagger/paths/circulation-rules.json [deleted file]
api/v1/swagger/paths/circulation-rules.yaml [new file with mode: 0644]
api/v1/swagger/paths/cities.yaml
api/v1/swagger/paths/clubs.json [deleted file]
api/v1/swagger/paths/clubs.yaml [new file with mode: 0644]
api/v1/swagger/paths/config_smtp_servers.json [deleted file]
api/v1/swagger/paths/config_smtp_servers.yaml [new file with mode: 0644]
api/v1/swagger/paths/holds.json [deleted file]
api/v1/swagger/paths/holds.yaml [new file with mode: 0644]
api/v1/swagger/paths/ill_backends.json [deleted file]
api/v1/swagger/paths/ill_backends.yaml [new file with mode: 0644]
api/v1/swagger/paths/illrequests.json [deleted file]
api/v1/swagger/paths/illrequests.yaml [new file with mode: 0644]
api/v1/swagger/paths/import_batch_profiles.json [deleted file]
api/v1/swagger/paths/import_batch_profiles.yaml [new file with mode: 0644]
api/v1/swagger/paths/items.yaml
api/v1/swagger/paths/libraries.json [deleted file]
api/v1/swagger/paths/libraries.yaml [new file with mode: 0644]
api/v1/swagger/paths/oauth.json [deleted file]
api/v1/swagger/paths/oauth.yaml [new file with mode: 0644]
api/v1/swagger/paths/patrons.json [deleted file]
api/v1/swagger/paths/patrons.yaml [new file with mode: 0644]
api/v1/swagger/paths/patrons_account.json [deleted file]
api/v1/swagger/paths/patrons_account.yaml [new file with mode: 0644]
api/v1/swagger/paths/patrons_extended_attributes.json [deleted file]
api/v1/swagger/paths/patrons_extended_attributes.yaml [new file with mode: 0644]
api/v1/swagger/paths/patrons_holds.json [deleted file]
api/v1/swagger/paths/patrons_holds.yaml [new file with mode: 0644]
api/v1/swagger/paths/patrons_password.json [deleted file]
api/v1/swagger/paths/patrons_password.yaml [new file with mode: 0644]
api/v1/swagger/paths/public_patrons.json [deleted file]
api/v1/swagger/paths/public_patrons.yaml [new file with mode: 0644]
api/v1/swagger/paths/quotes.json [deleted file]
api/v1/swagger/paths/quotes.yaml [new file with mode: 0644]
api/v1/swagger/paths/return_claims.json [deleted file]
api/v1/swagger/paths/return_claims.yaml [new file with mode: 0644]
api/v1/swagger/paths/rotas.json [deleted file]
api/v1/swagger/paths/rotas.yaml [new file with mode: 0644]
api/v1/swagger/paths/suggestions.yaml
api/v1/swagger/paths/transfer_limits.yaml
api/v1/swagger/swagger.yaml
api/v1/swagger/x-primitives.json [deleted file]
api/v1/swagger/x-primitives.yaml [new file with mode: 0644]