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

Bug 29810: Add summary of x-koha-embed header to api spec 

Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
This commit is contained in:
Martin Renvoize 2022-01-06 12:59:42 +00:00 committed by Fridolin Somers
parent 1445012f5f
commit c22fb1237f
1 changed files with 16 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -463,6 +463,9 @@ info:
"OR" query: `{ "field1": "value2", "field2": "value2" }` will filter the response to only those
results with both field1 containing value2 AND field2 containing value2 for example.
Additionally, if you are requesting related data be embedded into the response one can query
on the related data using dot notation in the field names.
### Examples
The following request would return any patron with firstname "Henry" and lastname "Acevedo";
@ -473,12 +476,24 @@ info:
`curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": { "-like": "Ace%" }"`
The following request would return any patron whilse lastname is "Acevedo" OR "Bernardo"
The following request would return any patron whose lastname is "Acevedo" OR "Bernardo"
`curl -u koha:koha --request GET "http://127.0.0.1:8081/api/v1/patrons/" --data-raw "{ "surname": [ "Acevedo", "Bernardo" ] }"`
The following request embeds the related patron extended attributes data and filters on it.
`curl -u koha:koha =--request GET 'http://127.0.0.1:8081/api/v1/patrons/' --header 'x-koha-embed: extended_attributes' --data-raw '{ "extended_attributes.code": "internet", "extended_attributes.attribute": "1" }'`
## Special headers
### x-koha-embed
This optional header allows the api consumer to request additional related data
to be returned in the api response. It also allows for cross referencing in the
queries as described above. It accepts a comma delimited list of relation names.
Relations may on occasion also support dot delimited nesting to allow traversal.
### x-koha-library
This optional header should be passed to give your api request a library