Koha/api/v1/swagger/paths.yaml
Tomas Cohen Arazi d6c67eddd3 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>
2021-12-07 12:33:35 -10:00

143 lines
6.5 KiB
YAML

---
/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}