From e5f791fd99e7d8e1c0e7aee5938dc09577e44591 Mon Sep 17 00:00:00 2001 From: Tomas Cohen Arazi Date: Mon, 8 Nov 2021 09:45:31 -0300 Subject: [PATCH] Bug 29183: (follow-up) Add x-koha-query option Signed-off-by: Tomas Cohen Arazi --- api/v1/swagger/swagger.yaml | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/api/v1/swagger/swagger.yaml b/api/v1/swagger/swagger.yaml index 1f75c3511e..1c06b55901 100644 --- a/api/v1/swagger/swagger.yaml +++ b/api/v1/swagger/swagger.yaml @@ -50,8 +50,12 @@ info: ## Filtering responses - The API allows for some advanced response filtering using a json based query syntax that - can be added as a query parameter, `q=` or in the request body. + The API allows for some advanced response filtering using a JSON based query syntax. The + query can be added to the requests: + + * as a query parameter `q=` + * in the request body + * in a special header `x-koha-query` For simple field equality matches we can use `{ "fieldname": "value" }` where the fieldname matches one of the fields as described in the particular endpoints response object. -- 2.32.0