Koha/api/v1/swagger/x-primitives.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

60 lines
1.3 KiB
YAML

---
biblio_id:
type: integer
description: Internal biblio identifier
advancededitormacro_id:
type: integer
description: Internal advanced editor macro identifier
readOnly: true
patron_id:
type: integer
description: Internal patron identifier
library_id:
type: string
description: internally assigned library identifier
maxLength: 10
minLength: 1
limit_id:
type: integer
description: Internal transfer limit identifier
cardnumber:
type:
- string
- "null"
description: library assigned user identifier
city_id:
type: integer
description: internally assigned city identifier
readOnly: true
email:
type:
- string
- "null"
description: primary email address for patron's primary address
firstname:
type:
- string
- "null"
description: patron's first name
phone:
type:
- string
- "null"
description: primary phone number for patron's primary address
surname:
type:
- string
- "null"
description: patron's last name
vendor_id:
type: integer
description: internally assigned vendor identifier
readOnly: true
fund_id:
type: integer
description: internally assigned fund identifier
readOnly: true
quote_id:
type: integer
description: internally assigned quote identifier
readOnly: true