[Bug 19948] New: Rest API documentation is out of date in Koha manual
https://bugs.koha-community.org/bugzilla3/show_bug.cgi?id=19948 Bug ID: 19948 Summary: Rest API documentation is out of date in Koha manual Change sponsored?: --- Product: Koha Version: master Hardware: All OS: All Status: NEW Severity: enhancement Priority: P5 - low Component: Documentation Assignee: koha-bugs@lists.koha-community.org Reporter: barton@bywatersolutions.com QA Contact: testopia@bugs.koha-community.org The 'REST services' documentation does not fit the current implementation of the koha rest API. For instance, the documentation shows a 'user' endpoint: GET user/byid/:borrowernumber/holds GET user/:user_name/holds GET user/byid/:borrowernumber/issues GET user/:user_name/issues GET user/:user_name/issues_history GET user/byid/:borrowernumber/issues_history GET user/today GET user/all POST user But the endpoint implemented in api/v1 is "patrons", e.g. https://intranet.bywatersolutions.com/api/v1/patrons/221 The best current documentation that I'm aware of is https://wiki.koha-community.org/wiki/REST_api_RFCs It would be nice to build this documentation via api/v1/spec see also bug 17694 -- 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=19948 Barton Chittenden <barton@bywatersolutions.com> changed: What |Removed |Added ---------------------------------------------------------------------------- Severity|enhancement |normal -- 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=19948 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- CC| |katrin.fischer@bsz-bw.de --- Comment #1 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- https://koha-community.org/manual/17.11/en/html/17_miscellaneous.html?highli... is not about our current implementation but about a patch/scripts Biblibre provided in the past to implement a REST API for Koha. I suggest removing that paragraph as Koha's REST API is still being developed and it will be hard to keep up with changes. Fast changing technical documentation seems better suited for the wiki atm. -- 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=19948 Katrin Fischer <katrin.fischer@bsz-bw.de> changed: What |Removed |Added ---------------------------------------------------------------------------- Resolution|--- |FIXED Status|NEW |RESOLVED --- Comment #2 from Katrin Fischer <katrin.fischer@bsz-bw.de> --- Content in current manuals has been updated: https://koha-community.org/manual/18.11/en/html/webservices.html?highlight=r... -- You are receiving this mail because: You are the assignee for the bug. You are watching all bug changes.
participants (1)
-
bugzilla-daemon@bugs.koha-community.org