227 lines
6.1 KiB
YAML
227 lines
6.1 KiB
YAML
---
|
|
/quotes:
|
|
get:
|
|
x-mojo-to: Quotes#list
|
|
operationId: listQuotes
|
|
tags:
|
|
- quotes
|
|
summary: List quotes
|
|
produces:
|
|
- application/json
|
|
parameters:
|
|
- name: quote_id
|
|
in: query
|
|
description: Case insensitive search on quote id
|
|
required: false
|
|
type: string
|
|
- name: source
|
|
in: query
|
|
description: Case insensitive search on source
|
|
required: false
|
|
type: string
|
|
- name: text
|
|
in: query
|
|
description: Case insensitive search on text
|
|
required: false
|
|
type: string
|
|
- name: displayed_on
|
|
in: query
|
|
description: Case Insensative search on last displayed date
|
|
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"
|
|
- $ref: "../swagger.yaml#/parameters/q_header"
|
|
- $ref: "../swagger.yaml#/parameters/request_id_header"
|
|
responses:
|
|
"200":
|
|
description: A list of quotes
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
"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:
|
|
catalogue: "1"
|
|
post:
|
|
x-mojo-to: Quotes#add
|
|
operationId: addQuote
|
|
tags:
|
|
- quotes
|
|
summary: Add quote
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new quote
|
|
required: true
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Quote added
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
"401":
|
|
description: Authentication required
|
|
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: edit_quotes
|
|
"/quotes/{quote_id}":
|
|
get:
|
|
x-mojo-to: Quotes#get
|
|
operationId: getQuote
|
|
tags:
|
|
- quotes
|
|
summary: Get quote
|
|
parameters:
|
|
- $ref: "../swagger.yaml#/parameters/quote_id_pp"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A Quote
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
"404":
|
|
description: Quote 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"
|
|
put:
|
|
x-mojo-to: Quotes#update
|
|
operationId: updateQuote
|
|
tags:
|
|
- quotes
|
|
summary: Update quote
|
|
parameters:
|
|
- $ref: "../swagger.yaml#/parameters/quote_id_pp"
|
|
- name: body
|
|
in: body
|
|
description: a quote object
|
|
required: true
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A quote
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/quote"
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Quote 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:
|
|
tools: edit_quotes
|
|
delete:
|
|
x-mojo-to: Quotes#delete
|
|
operationId: deleteQuote
|
|
tags:
|
|
- quotes
|
|
summary: Delete quote
|
|
parameters:
|
|
- $ref: "../swagger.yaml#/parameters/quote_id_pp"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Quote deleted
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Quote 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:
|
|
tools: edit_quotes
|