gitea
/
Koha-clms
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

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>
This commit is contained in:
Tomas Cohen Arazi 2022-03-30 13:54:24 +02:00 committed by Fridolin Somers
parent 9aea9241f3
commit b25f6f1c30
20 changed files with 29 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
api/v1/swagger/paths/acquisitions_funds.yaml
View File

@ -26,6 +26,7 @@
- $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 funds

1
api/v1/swagger/paths/acquisitions_orders.yaml
View File

@ -42,6 +42,7 @@
- $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 orders

1
api/v1/swagger/paths/acquisitions_vendors.yaml
View File

@ -26,6 +26,7 @@
- $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 vendors

1
api/v1/swagger/paths/advancededitormacros.yaml
View File

@ -36,6 +36,7 @@
- $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 macros

2
api/v1/swagger/paths/biblios.yaml
View File

@ -108,6 +108,7 @@
- $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"
- name: checked_in
in: query
description: By default, current checkouts are returned, when this is true then
@ -163,6 +164,7 @@
- $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"
consumes:
- application/json
produces:

1
api/v1/swagger/paths/cash_registers.yaml
View File

@ -17,6 +17,7 @@
- $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: Cashups performed on this register

1
api/v1/swagger/paths/checkouts.yaml
View File

@ -15,6 +15,7 @@
- $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"
- name: checked_in
in: query
description: By default, current checkouts are returned, when this is true then

1
api/v1/swagger/paths/cities.yaml
View File

@ -36,6 +36,7 @@
- $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 cities

1
api/v1/swagger/paths/config_smtp_servers.yaml
View File

@ -16,6 +16,7 @@
- $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 SMTP servers

2
api/v1/swagger/paths/holds.yaml
View File

@ -84,6 +84,7 @@
- $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:
@ -572,6 +573,7 @@
- $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:

1
api/v1/swagger/paths/import_batch_profiles.yaml
View File

@ -19,6 +19,7 @@
- $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"
consumes:
- application/json
produces:

2
api/v1/swagger/paths/items.yaml
View File

@ -19,6 +19,7 @@
- $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"
consumes:
- application/json
produces:
@ -113,6 +114,7 @@
- $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"
consumes:
- application/json
produces:

2
api/v1/swagger/paths/libraries.yaml
View File

@ -99,6 +99,7 @@
- $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:
@ -308,6 +309,7 @@
- $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:

1
api/v1/swagger/paths/patrons.yaml
View File

@ -351,6 +351,7 @@
- $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 patrons

1
api/v1/swagger/paths/patrons_extended_attributes.yaml
View File

@ -15,6 +15,7 @@
- $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:

1
api/v1/swagger/paths/patrons_holds.yaml
View File

@ -15,6 +15,7 @@
- $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:

1
api/v1/swagger/paths/quotes.yaml
View File

@ -36,6 +36,7 @@
- $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

1
api/v1/swagger/paths/suggestions.yaml
View File

@ -15,6 +15,7 @@
- $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:

1
api/v1/swagger/paths/transfer_limits.yaml
View File

@ -34,6 +34,7 @@
- $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:

6
api/v1/swagger/swagger.yaml
View File

@ -365,6 +365,12 @@ parameters:
name: quote_id
required: true
type: integer
request_id_header:
description: Request id header
in: header
name: x-koha-request-id
required: false
type: integer
seen_pp:
description: Item was seen flag
in: query