Koha/api/v1/swagger/paths/patrons_extended_attributes.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

278 lines
8.5 KiB
YAML

---
"/patrons/{patron_id}/extended_attributes":
get:
x-mojo-to: Patrons::Attributes#list_patron_attributes
operationId: getPatronAttributes
tags:
- patrons
summary: List extended attributes for a patron
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- $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: The patron extended attributes
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Patron 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:
borrowers: edit_borrowers
post:
x-mojo-to: Patrons::Attributes#add
operationId: addPatronAttribute
tags:
- patrons
summary: Add extended attribute for a patron
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- name: body
in: body
description: A JSON representation of the patron extended attribute
required: true
schema:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
produces:
- application/json
responses:
"201":
description: A successfully created patron extended attribute
schema:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
"400":
description: Bad parameter
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: Patron not found
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:
borrowers: edit_borrowers
put:
x-mojo-to: Patrons::Attributes#overwrite
operationId: overwritePatronAttributes
tags:
- patrons
summary: Overwrite extended attributes for a patron
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- name: body
in: body
description: A JSON representation of the patron extended attribute
required: true
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
produces:
- application/json
responses:
"200":
description: The successfully created patron extended attributes
schema:
type: array
items:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
"400":
description: Bad parameters
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: Patron not found
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:
borrowers: edit_borrowers
"/patrons/{patron_id}/extended_attributes/{extended_attribute_id}":
patch:
x-mojo-to: Patrons::Attributes#update
operationId: updatePatronAttribute
tags:
- patrons
summary: Update extended attribute
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- name: extended_attribute_id
in: path
description: Internal patron extended attribute identifier
type: integer
required: true
- name: body
in: body
description: An object containing the updated values for the patron extended
attribute
required: true
schema:
type: object
properties:
value:
description: Extended attribute value
type: string
additionalProperties: false
produces:
- application/json
responses:
"200":
description: A successfully updated patron extended attribute
schema:
$ref: "../swagger.yaml#/definitions/patron_extended_attribute"
"400":
description: Bad parameter
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: Object not found
schema:
$ref: "../swagger.yaml#/definitions/error"
"409":
description: Conflict in updating 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:
borrowers: edit_borrowers
delete:
x-mojo-to: Patrons::Attributes#delete
operationId: deletePatronAttribute
tags:
- patrons
summary: Delete extended attribute
parameters:
- $ref: "../swagger.yaml#/parameters/patron_id_pp"
- name: extended_attribute_id
in: path
description: Internal patron extended attribute identifier
type: integer
required: true
produces:
- application/json
responses:
"204":
description: Extended patron attribute deleted
"401":
description: Authentication required
schema:
$ref: "../swagger.yaml#/definitions/error"
"403":
description: Access forbidden
schema:
$ref: "../swagger.yaml#/definitions/error"
"404":
description: Patron 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:
borrowers: edit_borrowers