Koha/api/v1/swagger/definitions/ill_batch.yaml
Tomas Cohen Arazi a71140fe60
Bug 30719: (QA follow-up) Pick better column names and cleanup
This patch takes on normalizing the attribute names, embeds, and also
makes the whole API more kosher, in terms of using accessors for related
objects, using the standard structure for strings_map, etc.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-10-17 14:45:23 -03:00

60 lines
1.3 KiB
YAML

---
type: object
properties:
ill_batch_id:
type: integer
description: Internal ILL batch identifier
name:
type: string
description: Name of the ILL batch
backend:
type: string
description: Backend name
cardnumber:
type: string
description: Library assigned user identifier of the ILL batch
patron_id:
type: string
description: Internal identifier the patron of the ILL batch
library_id:
type: string
description: Internal identifier for the ILL batch's library
status_code:
type: string
description: Code of the status of the ILL batch
patron:
type:
- object
- "null"
description: The patron associated with the batch
library:
type:
- object
- "null"
description: The library associated with the batch
requests:
type:
- array
- "null"
description: The requests in this batch (x-koha-embed)
requests_count:
type:
- integer
- "null"
description: The number of requests in this batch (x-koha-embed)
status:
type:
- object
- "null"
description: The status associated with the batch (x-koha-embed)
_strings:
type:
- object
- "null"
description: Expanded coded fields (x-koha-embed)
additionalProperties: false
required:
- name
- backend
- library_id
- status_code