Tomas Cohen Arazi
ae43d0cfe0
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: David Nind <david@davidnind.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
125 lines
2.9 KiB
YAML
125 lines
2.9 KiB
YAML
---
|
|
swagger: "2.0"
|
|
basePath: /api/v1
|
|
paths:
|
|
$ref: paths.json
|
|
definitions:
|
|
$ref: definitions.json
|
|
parameters:
|
|
$ref: parameters.json
|
|
x-primitives:
|
|
$ref: x-primitives.json
|
|
info:
|
|
title: Koha REST API
|
|
version: "1"
|
|
license:
|
|
name: GPL v3,
|
|
url: http://www.gnu.org/licenses/gpl.txt
|
|
contact:
|
|
name: Koha Development Team
|
|
url: https://koha-community.org/
|
|
description: |
|
|
## Introduction
|
|
|
|
This API is documented in **OpenAPI format**.
|
|
|
|
## Special headers
|
|
|
|
### x-koha-library
|
|
|
|
This optional header should be passed to give your api request a library
|
|
context; If it is not included in the request, then the request context
|
|
will default to using your api comsumer's assigned home library.
|
|
tags:
|
|
- name: "biblios"
|
|
x-displayName: Biblios
|
|
description: |
|
|
Manage bibliographic records
|
|
- name: "cashups"
|
|
x-displayName: Cashups
|
|
description: |
|
|
Manage cash register cashups
|
|
- name: "checkouts"
|
|
x-displayName: Checkouts
|
|
description: |
|
|
Manage checkouts
|
|
- name: "circulation_rules"
|
|
x-displayName: Circulation rules
|
|
description: |
|
|
Manage circulation rules
|
|
- name: "cities"
|
|
x-displayName: Cities
|
|
description: |
|
|
Manage cities
|
|
- name: "clubs"
|
|
x-displayName: Clubs
|
|
description: |
|
|
Manage patron clubs
|
|
- name: "funds"
|
|
x-displayName: Funds
|
|
description: |
|
|
Manage funds for the acquisitions module
|
|
- name: "holds"
|
|
x-displayName: Holds
|
|
description: |
|
|
Manage holds
|
|
- name: "illbackends"
|
|
x-displayName: ILL backends
|
|
description: |
|
|
Manage ILL module backends
|
|
- name: "illrequests"
|
|
x-displayName: ILL requests
|
|
description: |
|
|
Manage ILL requests
|
|
- name: "items"
|
|
x-displayName: Items
|
|
description: |
|
|
Manage items
|
|
- name: "library"
|
|
x-displayName: Libraries
|
|
description: |
|
|
Manage libraries
|
|
- name: "macros"
|
|
x-displayName: Macros
|
|
description: |
|
|
Manage macros
|
|
- name: "orders"
|
|
x-displayName: Orders
|
|
description: |
|
|
Manage acquisition orders
|
|
- name: "oauth"
|
|
x-displayName: "OAuth"
|
|
description: |
|
|
Handle OAuth flows
|
|
- name: "patrons"
|
|
x-displayName: Patrons
|
|
description: |
|
|
Manage patrons
|
|
- name: "quotes"
|
|
x-displayName: Quotes
|
|
description: |
|
|
Manage quotes
|
|
- name: "return_claims"
|
|
x-displayName: Return claims
|
|
description: |
|
|
Manage return claims
|
|
- name: "rotas"
|
|
x-displayName: Rotas
|
|
description: |
|
|
Manage rotas
|
|
- name: "smtp_servers"
|
|
x-displayName: SMTP servers
|
|
description: |
|
|
Manage SMTP servers configurations
|
|
- name: "transfer"
|
|
x-displayName: Transfer limits
|
|
description: |
|
|
Manage transfer limits
|
|
- name: "vendors"
|
|
x-displayName: "Vendors"
|
|
description: |
|
|
Manage vendors for the acquisitions module
|
|
- name: "batch_import_profiles"
|
|
x-displayName: Batch import profiles
|
|
description: |
|
|
Manage batch import profiles
|