Koha/api/v1/swagger/definitions/authorised_value.yaml
Jonathan Druart 7e5c75549f
Bug 32981: Add endpoint to get AV for given category
For, at least, the ERM module we would like to retrieve the authorised
values for a given category to build a dropdown list with the different options.

It has been decided on bug 17390 to use
GET /authorised_value_categories/:authorised_value_category_id/values

Test plan:
curl -v -s -u koha:koha --request GET  http://kohadev-intra.mydnsname.org:8081/api/v1/authorised_value_categories/LOC/values
Should display the list of LOC

curl -v -s -u koha:koha --request GET  http://kohadev-intra.mydnsname.org:8081/api/v1/authorised_value_categories/xLOCx/values
Should return a 404

Signed-off-by: Pedro Amorim <pedro.amorim@ptfs-europe.com>
Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-03-02 12:00:10 -03:00

32 lines
792 B
YAML

---
type: object
properties:
authorised_value_id:
type: integer
description: internally assigned authorised value identifier
readOnly: true
category_name:
description: the category of this authorised value
type: string
value:
description: The code for this authorised value
type: string
description:
description: The staff interface description for this authorised value
type: string
opac_description:
description: The public interface description of this authorised value, if set"
type:
- string
- "null"
image_url:
description: The url of the image associated with this authorised value, if any
type:
- string
- "null"
additionalProperties: false
required:
- category_name
- value
- description