Bug 19948 - Rest API documentation is out of date in Koha manual
Summary: Rest API documentation is out of date in Koha manual
Status: CLOSED FIXED
Alias: None
Product: Koha
Classification: Unclassified
Component: Documentation (show other bugs)
Version: Main
Hardware: All All
: P5 - low normal (vote)
Assignee: Bugs List
QA Contact: Testopia
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2018-01-10 17:30 UTC by Barton Chittenden
Modified: 2020-01-06 20:15 UTC (History)
1 user (show)

See Also:
Change sponsored?: ---
Patch complexity: ---
Documentation contact:
Documentation submission:
Text to go in the release notes:
Version(s) released in:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Barton Chittenden 2018-01-10 17:30:20 UTC
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
Comment 1 Katrin Fischer 2018-01-10 22:03:57 UTC
https://koha-community.org/manual/17.11/en/html/17_miscellaneous.html?highlight=rest#rest-services 

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.
Comment 2 Katrin Fischer 2019-05-05 08:47:28 UTC
Content in current manuals has been updated:
https://koha-community.org/manual/18.11/en/html/webservices.html?highlight=rest#versioned-restful-api-effort