Koha/api/v1/swagger/paths/authorised_values.yaml
Tomas Cohen Arazi 3fc1f27524
Bug 33971: Remove x-koha-query header support
This patch removes support for the `x-koha-query` header entirely from
the codebase. For the purpose:

- $c->objects->search is adjusted
- Relevant tests are cleared/adapted
- The OpenAPI spec gets the header removed

To test:
1. Apply this patch and run:
   $ ktd --shell
  k$ prove t/db_dependent/Koha/REST/Plugin/Objects.t \
           t/Koha/REST/Plugin/Query.t \
           t/db_dependent/api/v1/*.t
=> SUCCESS: Tests pass!
2. Sign off :-D

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
2023-07-03 10:35:06 -03:00

84 lines
2.6 KiB
YAML

---
"/authorised_value_categories/{authorised_value_category_name}/authorised_values":
get:
x-mojo-to: AuthorisedValues#list_av_from_category
operationId: listAuthorisedValues
tags:
- authorised_values
summary: List authorised values for a given category
produces:
- application/json
parameters:
- description: category name
in: path
name: authorised_value_category_name
required: true
type: string
- description: Case insensitive search on authorised value id
in: query
name: authorised_value_id
required: false
type: integer
- description: Case insensitive search on authorised value category name
in: query
name: category_name
required: false
type: string
- description: Case insensitive search on value
in: query
name: value
required: false
type: string
- description: Case insensitive search on description
in: query
name: description
required: false
type: string
- description: Case insensitive search on opac description
in: query
name: opac_description
required: false
type: string
- description: Case insensitive search on image url
in: query
name: image_url
required: false
type: string
- $ref: "../swagger.yaml#/parameters/match"
- $ref: "../swagger.yaml#/parameters/order_by"
- $ref: "../swagger.yaml#/parameters/page"
- $ref: "../swagger.yaml#/parameters/per_page"
- $ref: "../swagger.yaml#/parameters/q_param"
- $ref: "../swagger.yaml#/parameters/q_body"
responses:
200:
description: A list of authorised values
schema:
items:
$ref: "../swagger.yaml#/definitions/authorised_value"
type: array
400:
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
403:
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
404:
description: Ressource not found
schema:
$ref: "../swagger.yaml#/definitions/error"
500:
description: |-
Internal server error. Possible `error_code` attribute values:
* `internal_server_error`
schema:
$ref: "../swagger.yaml#/definitions/error"
503:
description: Under maintenance
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
catalogue: 1