212 lines
5.8 KiB
YAML
212 lines
5.8 KiB
YAML
---
|
|
/suggestions:
|
|
get:
|
|
x-mojo-to: Suggestions#list
|
|
operationId: listSuggestions
|
|
description: This resource returns a list of purchase suggestions
|
|
summary: List purchase suggestions
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/match
|
|
- $ref: ../parameters.yaml#/order_by
|
|
- $ref: ../parameters.yaml#/page
|
|
- $ref: ../parameters.yaml#/per_page
|
|
- $ref: ../parameters.yaml#/q_param
|
|
- $ref: ../parameters.yaml#/q_body
|
|
- $ref: ../parameters.yaml#/q_header
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of suggestions
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
suggestions: suggestions_manage
|
|
post:
|
|
x-mojo-to: Suggestions#add
|
|
operationId: addSuggestions
|
|
description: This resource accepts a new purchase suggestion and creates it
|
|
summary: Add a purchase suggestion
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new suggestion
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
- name: x-koha-override
|
|
in: header
|
|
required: false
|
|
description: |
|
|
Overrides list sent as a request header
|
|
Valid values:
|
|
* any
|
|
* max_total
|
|
* max_pending
|
|
type: string
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Suggestion added
|
|
schema:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
suggestions: suggestions_manage
|
|
"/suggestions/{suggestion_id}":
|
|
get:
|
|
x-mojo-to: Suggestions#get
|
|
operationId: getSuggestion
|
|
description: This resource gives access to a specific purchase suggestion
|
|
summary: Get purchase suggestion
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/suggestion_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A suggestion
|
|
schema:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Suggestion not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
suggestions: suggestions_manage
|
|
put:
|
|
x-mojo-to: Suggestions#update
|
|
operationId: updateSuggestion
|
|
description: This resource allows updating an existing purchase suggestion
|
|
summary: Update purchase suggestion
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/suggestion_id_pp
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new hold
|
|
required: true
|
|
schema:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A suggestion
|
|
schema:
|
|
$ref: ../definitions.yaml#/suggestion
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Suggestion not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
suggestions: suggestions_manage
|
|
delete:
|
|
x-mojo-to: Suggestions#delete
|
|
operationId: deleteSuggestion
|
|
description: This resource deletes an existing purchase suggestion
|
|
summary: Delete purchase suggestion
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- $ref: ../parameters.yaml#/suggestion_id_pp
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Suggestion deleted
|
|
schema:
|
|
type: string
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"404":
|
|
description: Suggestion not found
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"500":
|
|
description: Internal error
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
"503":
|
|
description: Under maintenance
|
|
schema:
|
|
$ref: ../definitions.yaml#/error
|
|
x-koha-authorization:
|
|
permissions:
|
|
suggestions: suggestions_manage
|