Koha-community/Koha
13
7
Fork 0
Code Issues Releases Wiki Activity
Koha/api/v1/swagger/paths/libraries.yaml
Tomas Cohen Arazi b25f6f1c30 Bug 30394: Add x-koha-request-id support on API routes 
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>
2022-04-04 16:23:46 +02:00

376 lines
11 KiB
YAML
Raw Blame History

---
/libraries:
get:
x-mojo-to: Libraries#list
operationId: listLibraries
tags:
- libraries
summary: List libraries
parameters:
- name: name
in: query
description: Case insensitive 'starts-with' search on name
required: false
type: string
- name: address1
in: query
description: Case insensitive 'starts-with' search on address1
required: false
type: string
- name: address2
in: query
description: Case insensitive 'starts-with' search on address2
required: false
type: string
- name: address3
in: query
description: Case insensitive 'starts-with' search on address3
required: false
type: string
- name: postal_code
in: query
description: Case insensitive 'starts-with' search on postal code
required: false
type: string
- name: city
in: query
description: Case insensitive 'starts-with' search on city
required: false
type: string
- name: state
in: query
description: Case insensitive 'starts-with' search on state
required: false
type: string
- name: country
in: query
description: Case insensitive 'starts_with' search on country
required: false
type: string
- name: phone
in: query
description: Case insensitive 'starts_with' search on phone number
required: false
type: string
- name: fax
in: query
description: Case insensitive 'starts_with' search on fax number
required: false
type: string
- name: email
in: query
description: Case insensitive 'starts_with' search on email address
required: false
type: string
- name: reply_to_email
in: query
description: Case insensitive 'starts_with' search on Reply-To email address
required: false
type: string
- name: return_path_email
in: query
description: Case insensitive 'starts_with' search on Return-Path email address
required: false
type: string
- name: url
in: query
description: Case insensitive 'starts_with' search on website URL
required: false
type: string
- name: ip
in: query
description: Case insensitive 'starts_with' search on IP address
required: false
type: string
- name: notes
in: query
description: Case insensitive 'starts_with' search on notes
required: false
type: string
- name: opac_info
in: query
description: Case insensitive 'starts-with' search on OPAC info
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"
produces:
- application/json
responses:
"200":
description: A list of libraries
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/library"
"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"
x-koha-embed:
- smtp_server
post:
x-mojo-to: Libraries#add
operationId: addLibrary
tags:
- libraries
summary: Add library
parameters:
- name: body
in: body
description: A JSON object containing informations about the new library
required: true
schema:
$ref: "../swagger.yaml#/definitions/library"
produces:
- application/json
responses:
"201":
description: Library added
schema:
$ref: "../swagger.yaml#/definitions/library"
"400":
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"409":
description: Conflict in creating resource
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:
parameters: manage_libraries
"/libraries/{library_id}":
get:
x-mojo-to: Libraries#get
operationId: getLibrary
tags:
- libraries
summary: Get library
parameters:
- $ref: "../swagger.yaml#/parameters/library_id_pp"
produces:
- application/json
responses:
"200":
description: A library
schema:
$ref: "../swagger.yaml#/definitions/library"
"404":
description: Library not found
schema:
$ref: "../swagger.yaml#/definitions/error"
x-koha-authorization:
permissions:
catalogue: "1"
x-koha-embed:
- smtp_server
put:
x-mojo-to: Libraries#update
operationId: updateLibrary
tags:
- libraries
summary: Update library
parameters:
- $ref: "../swagger.yaml#/parameters/library_id_pp"
- name: body
in: body
description: A JSON object containing information on the library
required: true
schema:
$ref: "../swagger.yaml#/definitions/library"
consumes:
- application/json
produces:
- application/json
responses:
"200":
description: A library
schema:
$ref: "../swagger.yaml#/definitions/library"
"400":
description: Bad request
schema:
$ref: "../swagger.yaml#/definitions/error"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Library 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:
parameters: manage_libraries
delete:
x-mojo-to: Libraries#delete
operationId: deleteLibrary
tags:
- libraries
summary: Delete library
parameters:
- $ref: "../swagger.yaml#/parameters/library_id_pp"
produces:
- application/json
responses:
"204":
description: Library 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: Library 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:
parameters: manage_libraries
/public/libraries:
get:
x-mojo-to: Libraries#list
operationId: listLibrariesPublic
tags:
- libraries
summary: List libraries
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 libraries
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/library"
"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"
"/public/libraries/{library_id}":
get:
x-mojo-to: Libraries#get
operationId: getLibraryPublic
tags:
- libraries
summary: Get library (public)
parameters:
- $ref: "../swagger.yaml#/parameters/library_id_pp"
produces:
- application/json
responses:
"200":
description: A library
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Library not found
schema:
$ref: "../swagger.yaml#/definitions/error"
"406":
description: Not acceptable
schema:
type: array
description: Accepted content-types
items:
type: string
"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"
View git blame Copy permalink