api/v1/swagger/paths/authorised_value_categories.yaml

   1 ---
   2 /authorised_value_categories:
   3   get:
   4     x-mojo-to: AuthorisedValueCategories#list
   5     operationId: listAuthorisedValueCategories
   6     tags:
   7       - authorised_value_categories
   8     summary: List authorised value categories
   9     produces:
  10       - application/json
  11     parameters:
  12       - name: x-koha-embed
  13         in: header
  14         required: false
  15         description: Embed list sent as a request header
  16         type: array
  17         items:
  18           type: string
  19           enum:
  20             - authorised_values
  21         collectionFormat: csv
  22       - $ref: "../swagger.yaml#/parameters/match"
  23       - $ref: "../swagger.yaml#/parameters/order_by"
  24       - $ref: "../swagger.yaml#/parameters/page"
  25       - $ref: "../swagger.yaml#/parameters/per_page"
  26       - $ref: "../swagger.yaml#/parameters/q_param"
  27       - $ref: "../swagger.yaml#/parameters/q_body"
  28       - $ref: "../swagger.yaml#/parameters/q_header"
  29     responses:
  30       200:
  31         description: A list of authorised value categories
  32         schema:
  33           items:
  34             $ref: "../swagger.yaml#/definitions/authorised_value_category"
  35           type: array
  36       400:
  37         description: Bad request
  38         schema:
  39           $ref: "../swagger.yaml#/definitions/error"
  40       403:
  41         description: Access forbidden
  42         schema:
  43           $ref: "../swagger.yaml#/definitions/error"
  44       404:
  45         description: Resource not found
  46         schema:
  47           $ref: "../swagger.yaml#/definitions/error"
  48       500:
  49         description: |-
  50           Internal server error. Possible `error_code` attribute values:
  51           * `internal_server_error`
  52         schema:
  53           $ref: "../swagger.yaml#/definitions/error"
  54       503:
  55         description: Under maintenance
  56         schema:
  57           $ref: "../swagger.yaml#/definitions/error"
  58     x-koha-authorization:
  59       permissions:
  60         catalogue: 1