Tomas Cohen Arazi
b25f6f1c30
This patch adds the x-koha-request-id to all GET routes that rely on objects.search, for immediate support for the header. The patch itself is trivial: - It adds the header parameter definition to the top level swagger.yaml - It adds a reference on each route that already implements q params, etc To test: 1. Apply the patch 2. Reload plack 3. Notice the API still works 4. Run: $ kshell k$ prove t/db_dependent/api/v1/query.t => SUCCESS: It now passes! The /cities route implements the x-koha-request-id header pass through. 5. Run the rest of the API tests => SUCCESS: All good 6. Sign off :-D Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io> Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
262 lines
7.9 KiB
YAML
262 lines
7.9 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: "../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"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of suggestions
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../swagger.yaml#/definitions/suggestion"
|
|
"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:
|
|
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: "../swagger.yaml#/definitions/suggestion"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"201":
|
|
description: Suggestion added
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/suggestion"
|
|
"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:
|
|
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: "../swagger.yaml#/parameters/suggestion_id_pp"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A suggestion
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/suggestion"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Suggestion 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:
|
|
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: "../swagger.yaml#/parameters/suggestion_id_pp"
|
|
- name: body
|
|
in: body
|
|
description: A JSON object containing informations about the new hold
|
|
required: true
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/suggestion"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A suggestion
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/suggestion"
|
|
"400":
|
|
description: Bad request
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Suggestion 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:
|
|
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: "../swagger.yaml#/parameters/suggestion_id_pp"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"204":
|
|
description: Suggestion deleted
|
|
schema:
|
|
type: string
|
|
"401":
|
|
description: Authentication required
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"403":
|
|
description: Access forbidden
|
|
schema:
|
|
$ref: "../swagger.yaml#/definitions/error"
|
|
"404":
|
|
description: Suggestion 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:
|
|
suggestions: suggestions_manage
|
|
/suggestions/managers:
|
|
get:
|
|
x-mojo-to: Suggestions#list_managers
|
|
operationId: listSuggestionsManagers
|
|
description: This resource returns a list of patron allowed to be a manager for suggestions
|
|
summary: List possibe managers for suggestions
|
|
tags:
|
|
- suggestions
|
|
parameters:
|
|
- $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"
|
|
produces:
|
|
- application/json
|
|
responses:
|
|
"200":
|
|
description: A list of suggestions' managers
|
|
schema:
|
|
type: array
|
|
items:
|
|
$ref: "../swagger.yaml#/definitions/patron"
|
|
"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:
|
|
suggestions: suggestions_manage
|
|
x-koha-embed:
|
|
- extended_attributes
|