Koha/api/v1/swagger
Tomas Cohen Arazi 18ee07409a Bug 27855: Add 'extended_attributes' embedding to the spec
This patch just adds:
- The optional 'extended_attribute' attribute to the patron object
  OpenAPI definition. It consists of an array of extended_attribute
  objects.
- Add the x-koha-embed: [ 'extended_attributes' ] definition on the GET
  routes for patrons, allowing immedite availability of the
  'extended_attributes' embedding feature.

To test:
1. Apply this patchset
2. Restart Plack
3. Have some known patron_id/borrowernumber that has some extended
   attributes ('Patron attributes' on the UI).
4. Enable Basic authentication
5. Assuming the known patron_id is 1, point your favourite REST tool to http://kohadev-intra.myDNSname.org:8081/api/v1/patrons/1
   e.g.: if your user/pass is koha/koha
   curl --location --request GET 'http://kohadev-intra.myDNSname.org:8081/api/v1/patrons/1' \
        --header 'Content-Type: application/json' \
        --header 'Authorization: Basic a29oYTprb2hh'
=> SUCCESS: You get the patron object correctly, no extended_attributes
6. Repeat 5, adding the x-koha-embed header like this:
   curl --location --request GET 'http://kohadev-intra.myDNSname.org:8081/api/v1/patrons/1' \
        --header 'Content-Type: application/json' \
        --header 'x-koha-embed: extended_attributes' \
        --header 'Authorization: Basic a29oYTprb2hh'
=> SUCCESS: You get the patron, with the extended attributes inside!
7. Sign off :-D

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
2021-03-09 10:31:47 +01:00
..
definitions Bug 27855: Add 'extended_attributes' embedding to the spec 2021-03-09 10:31:47 +01:00
parameters Bug 26274: Add cashups api routes 2021-02-12 12:33:41 +01:00
paths Bug 27855: Add 'extended_attributes' embedding to the spec 2021-03-09 10:31:47 +01:00
definitions.json Bug 26274: Add cashups api routes 2021-02-12 12:33:41 +01:00
parameters.json Bug 27680: Add support for sorting fields with multiple data points 2021-03-01 13:50:03 +01:00
paths.json Bug 26274: Add cashups api routes 2021-02-12 12:33:41 +01:00
swagger.json
x-primitives.json Bug 27251: Rewrite QOTD with the Koha REST API 2021-01-29 09:03:45 +01:00