Koha-clms/api/v1/swagger/paths/additional_fields.yaml

49 lines
1.5 KiB
YAML

---
/additional_fields:
get:
x-mojo-to: AdditionalFields#list
operationId: listAdditionalFields
tags:
- additional_fields
summary: List additional fields
produces:
- application/json
parameters:
- description: filter by table name
in: query
name: tablename
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 additional_fields
schema:
items:
$ref: "../swagger.yaml#/definitions/additional_field"
type: array
400:
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
403:
description: Access forbidden
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:
tools: manage_additional_fields