Bug 28189: Move swagger file to YAML format
authorTomas Cohen Arazi <tomascohen@theke.io>
Wed, 21 Apr 2021 15:18:31 +0000 (12:18 -0300)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Wed, 12 May 2021 15:39:36 +0000 (17:39 +0200)
commit3c16e0110e62f57d7eedf07d9ffe3ddc334f4070
treeaa75ae8357b37b68ea939d685b5c0bcab85c0d5f
parentb2612d32390fc5e6825427799f9ddc1c7f949982
Bug 28189: Move swagger file to YAML format

This patch changes the base OpenAPI file (swagger.json) into YAML. The
motivation for this, is adding more documentation, in Markdown.

JSON doesn't accept multiline strings, so this seems like a good move
for readability.

To test:
1. Verify your API is functional
2. Apply this patch
3. Repeat 1
=> SUCCESS: No changes, really
4. Point your browser to /api/v1/.html
=> SUCCESS: Some nicely formatted description of the API can be seen. It
includes information about x-koha-library.
5. 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: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Koha/REST/V1.pm
api/v1/swagger/swagger.json [deleted file]
api/v1/swagger/swagger.yaml [new file with mode: 0644]