Bug 28842

Summary: Missing summary for /items/:item_id/pickup_locations
Product: Koha Reporter: Tomás Cohen Arazi <tomascohen>
Component: REST APIAssignee: Tomás Cohen Arazi <tomascohen>
Status: RESOLVED FIXED QA Contact: Martin Renvoize <martin.renvoize>
Severity: minor    
Priority: P5 - low CC: david, martin.renvoize
Version: master   
Hardware: All   
OS: All   
URL: https://api.koha-community.org/#operation/getItemPickupLocations
Change sponsored?: --- Patch complexity: ---
Documentation contact: Documentation submission:
Text to go in the release notes:
Version(s) released in:
21.11.00
Bug Depends on: 27931, 28461    
Bug Blocks:    
Attachments: Bug 28842: A summary to the /items/:item_id/pickup_locations route
Bug 28842: A summary to the /items/:item_id/pickup_locations route
Bug 28842: A summary to the /items/:item_id/pickup_locations route

Description Tomás Cohen Arazi 2021-08-11 11:56:49 UTC
Bug 27931 introduced /items/:item_id/pickup_locations but missed to add the route summary and the top level display title for the 'pickup_locations' tag.
Comment 1 Tomás Cohen Arazi 2021-08-11 12:09:07 UTC
Created attachment 123787 [details] [review]
Bug 28842: A summary to the /items/:item_id/pickup_locations route

This patch simply adds a summary to the route. This will be picked by
the API docs.

It also removes the 'pickup_locations' tag, as we did in bug 28461.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Comment 2 David Nind 2021-08-12 11:37:48 UTC
Created attachment 123810 [details] [review]
Bug 28842: A summary to the /items/:item_id/pickup_locations route

This patch simply adds a summary to the route. This will be picked by
the API docs.

It also removes the 'pickup_locations' tag, as we did in bug 28461.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>

Signed-off-by: David Nind <david@davidnind.com>
Comment 3 David Nind 2021-08-12 11:39:41 UTC
Testing notes (koha-testing-docker):

1. Enable RESTPublicAPI system preference.
2. Go to http://127.0.0.1:8080/api/v1/.html
3. Search for getItemPickupLocations
4. Text immediately after should say "This resource is not documented."
5. Apply the patch, flush_memcached, restart_all.
6. Refresh the page.
7. The text should now say "Get valid pickup locations for an item"
Comment 4 Martin Renvoize 2021-08-13 12:46:11 UTC
Created attachment 123824 [details] [review]
Bug 28842: A summary to the /items/:item_id/pickup_locations route

This patch simply adds a summary to the route. This will be picked by
the API docs.

It also removes the 'pickup_locations' tag, as we did in bug 28461.

Signed-off-by: Tomas Cohen Arazi <tomascohen@theke.io>
Signed-off-by: David Nind <david@davidnind.com>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Comment 5 Martin Renvoize 2021-08-13 12:46:48 UTC
Nice fix, no typos or spelling issues.

Passing QA
Comment 6 Jonathan Druart 2021-08-16 10:05:25 UTC
Pushed to master for 21.11, thanks to everybody involved!
Comment 7 Tomás Cohen Arazi 2021-08-31 17:54:57 UTC
Please backport to 21.05.