Koha/api/v1/swagger/definitions/allows_renewal.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

21 lines
560 B
YAML

---
type: object
properties:
allows_renewal:
type: boolean
description: Renewability status; true = renewable, false = not renewable
max_renewals:
type: integer
description: Maximum number of possible renewals
current_renewals:
type: integer
description: Current used renewals
unseen_renewals:
type: integer
description: Number of consecutive times the item was renewed without being seen
error:
type:
- string
- "null"
description: Description on false allows_renewal.
additionalProperties: false