[Bug 22615] New: Add /ill_backends endpoint
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Bug ID: 22615 Summary: Add /ill_backends endpoint Change sponsored?: --- Product: Koha Version: unspecified Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: REST api Assignee: koha-bugs@lists.koha-community.org Reporter: josef.moravec@gmail.com Target Milestone: --- -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Assignee|koha-bugs@lists.koha-commun |josef.moravec@gmail.com |ity.org | CC| |andrew.isherwood@ptfs-europ | |e.com URL| |https://wiki.koha-community | |.org/wiki/Illbackends_endpo | |int_RFC -- You are receiving this mail because: You are watching all bug changes. You are the assignee for the bug.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #1 from Josef Moravec <josef.moravec@gmail.com> --- Created attachment 87284 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=87284&action=edit Bug 22615: Add /ill_backends endpoint -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |Needs Signoff --- Comment #2 from Josef Moravec <josef.moravec@gmail.com> --- This is work-in-progress, but I am sharing it in hope I got some feedback. We need to think of what should be capabilities structure presented in response. For now I used raw data returned by $backend->capabilities method. -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #3 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- Hi Josef Looking good so far :) Do you have any details of your intended use case(s) for this endpoint, as that may help inform what the capabilities structure should be. Is this intended to be functionally distinct from the 'capabilities' embed on the GET /illrequests endpoint? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #4 from Josef Moravec <josef.moravec@gmail.com> --- (In reply to Andrew Isherwood from comment #3)
Hi Josef
Looking good so far :)
Do you have any details of your intended use case(s) for this endpoint, as that may help inform what the capabilities structure should be.
Is this intended to be functionally distinct from the 'capabilities' embed on the GET /illrequests endpoint?
This would be useful for external api clients to know the backends and its capabilities before the request is created - for example unmediated ill through other opacs like VuFind. Another use case could be for creating ill systems (at district, national level for example...) It is not intended to be distinct from /illrequests endpoint, but I think backends another resources, so should have own endpoint ;) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #5 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- I think the structure currently returned in /illrequests?embed=capabilities (which is just a JSON representation of what is returned from $backend->capabilities) is fairly logical: { "CANCREQ": { "id": "CANCREQ", "method": 0, "name": "Cancellation requested", "next_actions": ["KILL", "REQ", "MIG"], "prev_actions": ["NEW"], "ui_method_icon": 0, "ui_method_name": 0 }, "COMP": { "id": "COMP", "method": "mark_completed", "name": "Completed", "next_actions": [], "prev_actions": ["REQ"], "ui_method_icon": "fa-check", "ui_method_name": "Mark completed" }, "EDITITEM": { "id": "EDITITEM", "method": "edititem", "name": "Edited item metadata", "next_actions": [], "prev_actions": ["NEW"], "ui_method_icon": "fa-edit", "ui_method_name": "Edit item metadata" }, "GENREQ": { "id": "GENREQ", "method": "generic_confirm", "name": "Requested from partners", "next_actions": ["COMP", "MIG"], "prev_actions": ["NEW", "REQREV", "MIG"], "ui_method_icon": "fa-send-o", "ui_method_name": "Place request with partners" }, "KILL": { "id": "KILL", "method": "delete", "name": 0, "next_actions": [], "prev_actions": ["QUEUED", "REQREV", "NEW", "CANCREQ", "MIG"], "ui_method_icon": "fa-trash", "ui_method_name": "Delete request" }, "MIG": { "id": "MIG", "method": "migrate", "name": "Switched provider", "next_actions": ["REQ", "GENREQ", "KILL", "MIG"], "prev_actions": ["NEW", "REQ", "GENREQ", "REQREV", "QUEUED", "CANCREQ", "MIG"], "ui_method_icon": "fa-search", "ui_method_name": "Switch provider" }, "NEW": { "id": "NEW", "method": "create", "name": "New request", "next_actions": ["REQ", "GENREQ", "KILL", "MIG", "EDITITEM"], "prev_actions": [], "ui_method_icon": "fa-plus", "ui_method_name": "New request" }, "QUEUED": { "id": "QUEUED", "method": 0, "name": "Queued request", "next_actions": ["REQ", "KILL", "MIG"], "prev_actions": [], "ui_method_icon": 0, "ui_method_name": 0 }, "REQ": { "id": "REQ", "method": "confirm", "name": "Requested", "next_actions": ["REQREV", "COMP", "MIG"], "prev_actions": ["NEW", "REQREV", "QUEUED", "CANCREQ", "MIG"], "ui_method_icon": "fa-check", "ui_method_name": "Confirm request" }, "REQREV": { "id": "REQREV", "method": "cancel", "name": "Request reverted", "next_actions": ["REQ", "GENREQ", "KILL", "MIG"], "prev_actions": ["REQ"], "ui_method_icon": "fa-times", "ui_method_name": "Revert Request" } } So maybe a JSON object, keyed on backend name (e.g. BLDSS, FreeForm), with the the object being the above object? So: { "BLDSS": { "CANCREQ": { "id": "CANCREQ", "method": 0, "name": "Cancellation requested", "next_actions": ["KILL", "REQ", "MIG"], "prev_actions": ["NEW"], "ui_method_icon": 0, "ui_method_name": 0 }, [..etc..] }, "FreeForm": { [...etc...] } } Having an object keyed on name, rather than an array would slightly simplify lookup. In addition to getting all backends, I'm guessing it would be useful to have a search endpoint, such as /ill_backends?backend=FreeForm , which would just return a single backend. Hope this is helpful?! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #6 from Josef Moravec <josef.moravec@gmail.com> --- (In reply to Andrew Isherwood from comment #5)
I think the structure currently returned in /illrequests?embed=capabilities (which is just a JSON representation of what is returned from $backend->capabilities) is fairly logical:
{ "CANCREQ": { "id": "CANCREQ", "method": 0, "name": "Cancellation requested", "next_actions": ["KILL", "REQ", "MIG"], "prev_actions": ["NEW"], "ui_method_icon": 0, "ui_method_name": 0 }, "COMP": { "id": "COMP", "method": "mark_completed", "name": "Completed", "next_actions": [], "prev_actions": ["REQ"], "ui_method_icon": "fa-check", "ui_method_name": "Mark completed" }, "EDITITEM": { "id": "EDITITEM", "method": "edititem", "name": "Edited item metadata", "next_actions": [], "prev_actions": ["NEW"], "ui_method_icon": "fa-edit", "ui_method_name": "Edit item metadata" }, "GENREQ": { "id": "GENREQ", "method": "generic_confirm", "name": "Requested from partners", "next_actions": ["COMP", "MIG"], "prev_actions": ["NEW", "REQREV", "MIG"], "ui_method_icon": "fa-send-o", "ui_method_name": "Place request with partners" }, "KILL": { "id": "KILL", "method": "delete", "name": 0, "next_actions": [], "prev_actions": ["QUEUED", "REQREV", "NEW", "CANCREQ", "MIG"], "ui_method_icon": "fa-trash", "ui_method_name": "Delete request" }, "MIG": { "id": "MIG", "method": "migrate", "name": "Switched provider", "next_actions": ["REQ", "GENREQ", "KILL", "MIG"], "prev_actions": ["NEW", "REQ", "GENREQ", "REQREV", "QUEUED", "CANCREQ", "MIG"], "ui_method_icon": "fa-search", "ui_method_name": "Switch provider" }, "NEW": { "id": "NEW", "method": "create", "name": "New request", "next_actions": ["REQ", "GENREQ", "KILL", "MIG", "EDITITEM"], "prev_actions": [], "ui_method_icon": "fa-plus", "ui_method_name": "New request" }, "QUEUED": { "id": "QUEUED", "method": 0, "name": "Queued request", "next_actions": ["REQ", "KILL", "MIG"], "prev_actions": [], "ui_method_icon": 0, "ui_method_name": 0 }, "REQ": { "id": "REQ", "method": "confirm", "name": "Requested", "next_actions": ["REQREV", "COMP", "MIG"], "prev_actions": ["NEW", "REQREV", "QUEUED", "CANCREQ", "MIG"], "ui_method_icon": "fa-check", "ui_method_name": "Confirm request" }, "REQREV": { "id": "REQREV", "method": "cancel", "name": "Request reverted", "next_actions": ["REQ", "GENREQ", "KILL", "MIG"], "prev_actions": ["REQ"], "ui_method_icon": "fa-times", "ui_method_name": "Revert Request" } }
So maybe a JSON object, keyed on backend name (e.g. BLDSS, FreeForm), with the the object being the above object? So:
{ "BLDSS": { "CANCREQ": { "id": "CANCREQ", "method": 0, "name": "Cancellation requested", "next_actions": ["KILL", "REQ", "MIG"], "prev_actions": ["NEW"], "ui_method_icon": 0, "ui_method_name": 0 }, [..etc..] }, "FreeForm": { [...etc...] } }
Having an object keyed on name, rather than an array would slightly simplify lookup.
I used array, because of consistancy with other endpoints - we always return array on search, otherwise, I think we could stick with raw capabilites, as it is
In addition to getting all backends, I'm guessing it would be useful to have a search endpoint, such as /ill_backends?backend=FreeForm , which would just return a single backend.
Yes, that could be useful.
Hope this is helpful?!
It is! ;) -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #7 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- (In reply to Josef Moravec from comment #6)
I used array, because of consistancy with other endpoints - we always return array on search <snip>
Yes, good point! Do you think this needs more discussion or would you be happy for me to sign it off? -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |ASSIGNED --- Comment #8 from Josef Moravec <josef.moravec@gmail.com> --- (In reply to Andrew Isherwood from comment #7)
(In reply to Josef Moravec from comment #6)
I used array, because of consistancy with other endpoints - we always return array on search <snip>
Yes, good point!
Do you think this needs more discussion or would you be happy for me to sign it off?
I'll add the get one method, polish rfc and you can then sign off i think, I'll bring it to development meeting next week for discussion/voting. Thanks for your feedback! -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Michal Denar <black23@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |black23@gmail.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #87284|0 |1 is obsolete| | --- Comment #9 from Josef Moravec <josef.moravec@gmail.com> --- Created attachment 97735 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97735&action=edit Bug 22615: Add /ill_backends endpoint -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #10 from Josef Moravec <josef.moravec@gmail.com> --- Created attachment 97736 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97736&action=edit Bug 22615: Add endpoint for getting one ill backend -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #11 from Josef Moravec <josef.moravec@gmail.com> --- Created attachment 97737 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97737&action=edit Bug 22615: Fix perlcritic -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Josef Moravec <josef.moravec@gmail.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|ASSIGNED |Needs Signoff --- Comment #12 from Josef Moravec <josef.moravec@gmail.com> --- The RFC was voted some time ago. Now I added a single backend endpoint. Test plan: 1) Apply the patch 2) restart_all 3) Try to get all backends using /ill_backends endpoint 4) Try to get one backend using /ill_backends/{backend_id/name} for exampler /ill_backends/FreeForm -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Andrew Isherwood <andrew.isherwood@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Needs Signoff |Signed Off -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Andrew Isherwood <andrew.isherwood@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #97735|0 |1 is obsolete| | --- Comment #13 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- Created attachment 97742 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97742&action=edit Bug 22615: Add /ill_backends endpoint Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Andrew Isherwood <andrew.isherwood@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #97736|0 |1 is obsolete| | --- Comment #14 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- Created attachment 97743 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97743&action=edit Bug 22615: Add endpoint for getting one ill backend Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Andrew Isherwood <andrew.isherwood@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #97737|0 |1 is obsolete| | --- Comment #15 from Andrew Isherwood <andrew.isherwood@ptfs-europe.com> --- Created attachment 97744 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=97744&action=edit Bug 22615: Fix perlcritic Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Status|Signed Off |Passed QA -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Kyle M Hall <kyle@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Attachment #97742|0 |1 is obsolete| | Attachment #97743|0 |1 is obsolete| | Attachment #97744|0 |1 is obsolete| | --- Comment #16 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 100148 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=100148&action=edit Bug 22615: Add /ill_backends endpoint Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #17 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 100149 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=100149&action=edit Bug 22615: Add endpoint for getting one ill backend Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #18 from Kyle M Hall <kyle@bywatersolutions.com> --- Created attachment 100150 --> https://bugs.koha-community.org/bugzilla3/attachment.cgi?id=100150&action=edit Bug 22615: Fix perlcritic Signed-off-by: Andrew Isherwood <andrew.isherwood@ptfs-europe.com> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Version(s)| |20.05.00 released in| | Status|Passed QA |Pushed to master -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 --- Comment #19 from Martin Renvoize <martin.renvoize@ptfs-europe.com> --- Nice work everyone! Pushed to master for 20.05 -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Joy Nelson <joy@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |joy@bywatersolutions.com --- Comment #20 from Joy Nelson <joy@bywatersolutions.com> --- enhancement not backported to 19.11.x -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|enhancement |new feature CC| |martin.renvoize@ptfs-europe | |.com -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Summary|Add /ill_backends endpoint |Add routes for | |/ill_backends -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Martin Renvoize <martin.renvoize@ptfs-europe.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|new feature |enhancement -- You are receiving this mail because: You are watching all bug changes.
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=22615 Andrew Isherwood <bugzilla@warmlight.co.uk> changed: What |Removed |Added ---------------------------------------------------------------------------- CC|bugzilla@warmlight.co.uk | -- You are receiving this mail because: You are watching all bug changes.
participants (1)
-
bugzilla-daemon＠bugs.koha-community.org