@@ -, +, @@ - 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 $ kshell k$ prove t/db_dependent/api/v1/query.t --- api/v1/swagger/paths/acquisitions_funds.yaml | 1 + api/v1/swagger/paths/acquisitions_orders.yaml | 1 + api/v1/swagger/paths/acquisitions_vendors.yaml | 1 + api/v1/swagger/paths/advancededitormacros.yaml | 1 + api/v1/swagger/paths/biblios.yaml | 2 ++ api/v1/swagger/paths/cash_registers.yaml | 1 + api/v1/swagger/paths/checkouts.yaml | 1 + api/v1/swagger/paths/cities.yaml | 1 + api/v1/swagger/paths/config_smtp_servers.yaml | 1 + api/v1/swagger/paths/holds.yaml | 2 ++ api/v1/swagger/paths/import_batch_profiles.yaml | 1 + api/v1/swagger/paths/items.yaml | 2 ++ api/v1/swagger/paths/libraries.yaml | 2 ++ api/v1/swagger/paths/patrons.yaml | 1 + api/v1/swagger/paths/patrons_extended_attributes.yaml | 1 + api/v1/swagger/paths/patrons_holds.yaml | 1 + api/v1/swagger/paths/quotes.yaml | 1 + api/v1/swagger/paths/suggestions.yaml | 1 + api/v1/swagger/paths/transfer_limits.yaml | 1 + api/v1/swagger/swagger.yaml | 6 ++++++ 20 files changed, 29 insertions(+) --- a/api/v1/swagger/paths/acquisitions_funds.yaml +++ a/api/v1/swagger/paths/acquisitions_funds.yaml @@ -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 --- a/api/v1/swagger/paths/acquisitions_orders.yaml +++ a/api/v1/swagger/paths/acquisitions_orders.yaml @@ -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 --- a/api/v1/swagger/paths/acquisitions_vendors.yaml +++ a/api/v1/swagger/paths/acquisitions_vendors.yaml @@ -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 --- a/api/v1/swagger/paths/advancededitormacros.yaml +++ a/api/v1/swagger/paths/advancededitormacros.yaml @@ -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 --- a/api/v1/swagger/paths/biblios.yaml +++ a/api/v1/swagger/paths/biblios.yaml @@ -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: --- a/api/v1/swagger/paths/cash_registers.yaml +++ a/api/v1/swagger/paths/cash_registers.yaml @@ -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 --- a/api/v1/swagger/paths/checkouts.yaml +++ a/api/v1/swagger/paths/checkouts.yaml @@ -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 --- a/api/v1/swagger/paths/cities.yaml +++ a/api/v1/swagger/paths/cities.yaml @@ -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 --- a/api/v1/swagger/paths/config_smtp_servers.yaml +++ a/api/v1/swagger/paths/config_smtp_servers.yaml @@ -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 --- a/api/v1/swagger/paths/holds.yaml +++ a/api/v1/swagger/paths/holds.yaml @@ -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: --- a/api/v1/swagger/paths/import_batch_profiles.yaml +++ a/api/v1/swagger/paths/import_batch_profiles.yaml @@ -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: --- a/api/v1/swagger/paths/items.yaml +++ a/api/v1/swagger/paths/items.yaml @@ -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: --- a/api/v1/swagger/paths/libraries.yaml +++ a/api/v1/swagger/paths/libraries.yaml @@ -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: --- a/api/v1/swagger/paths/patrons.yaml +++ a/api/v1/swagger/paths/patrons.yaml @@ -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 --- a/api/v1/swagger/paths/patrons_extended_attributes.yaml +++ a/api/v1/swagger/paths/patrons_extended_attributes.yaml @@ -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: --- a/api/v1/swagger/paths/patrons_holds.yaml +++ a/api/v1/swagger/paths/patrons_holds.yaml @@ -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: --- a/api/v1/swagger/paths/quotes.yaml +++ a/api/v1/swagger/paths/quotes.yaml @@ -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 --- a/api/v1/swagger/paths/suggestions.yaml +++ a/api/v1/swagger/paths/suggestions.yaml @@ -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: --- a/api/v1/swagger/paths/transfer_limits.yaml +++ a/api/v1/swagger/paths/transfer_limits.yaml @@ -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: --- a/api/v1/swagger/swagger.yaml +++ a/api/v1/swagger/swagger.yaml @@ -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 --