79 lines
2.3 KiB
YAML
79 lines
2.3 KiB
YAML
---
|
|
"/public/additional_contents":
|
|
get:
|
|
x-mojo-to: AdditionalContents#list_public
|
|
operationId: listAdditionalContents
|
|
parameters:
|
|
- description: Case insensitive search on additional_contents id
|
|
in: query
|
|
name: additional_content_id
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on additional_contents category
|
|
in: query
|
|
name: category
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on additional_contents code
|
|
in: query
|
|
name: code
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on additional_contents location
|
|
in: query
|
|
name: location
|
|
required: false
|
|
type: string
|
|
- description: Case insensitive search on additional_contents library_id
|
|
in: query
|
|
name: library_id
|
|
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"
|
|
- name: x-koha-embed
|
|
in: header
|
|
required: false
|
|
description: Embed list sent as a request header
|
|
type: array
|
|
items:
|
|
type: string
|
|
enum:
|
|
- translated_contents
|
|
collectionFormat: csv
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
200:
|
|
description: A list of additional contents
|
|
schema:
|
|
items:
|
|
$ref: ../swagger.yaml#/definitions/additional_content
|
|
type: array
|
|
400:
|
|
description: |
|
|
Bad request. Possible `error_code` attribute values:
|
|
|
|
* `invalid_query`
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
403:
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../swagger.yaml#/definitions/error
|
|
500:
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../swagger.yaml#/definitions/error
|
|
503:
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../swagger.yaml#/definitions/error
|
|
summary: List public additional contents
|
|
tags:
|
|
- additional_contents
|