Bug 28189: Move swagger file to YAML format
[koha.git] / api / v1 / swagger / swagger.yaml
1 ---
2 swagger: 2.0
3 basePath: /api/v1
4 paths:
5   $ref: paths.json
6 definitions:
7   $ref: definitions.json
8 parameters:
9   $ref: parameters.json
10 x-primitives:
11   $ref: x-primitives.json
12 info:
13   title: Koha REST API
14   version: 1
15   license:
16     name: GPL v3,
17     url: http://www.gnu.org/licenses/gpl.txt
18   contact:
19     name: Koha Development Team
20     url: https://koha-community.org/
21   description: |
22     ## Introduction
23
24     This API is documented in **OpenAPI format**.
25
26     ## Special headers
27
28     ### x-koha-library
29
30     This optional header should be passed to give your api request a library
31     context; If it is not included in the request, then the request context
32     will default to using your api comsumer's assigned home library.