[Koha-bugs] [Bug 19948] New: Rest API documentation is out of date in Koha manual

[bugzilla-daemon at bugs.koha-community.org]

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 at lists.koha-community.org
          Reporter: barton at bywatersolutions.com
        QA Contact: testopia at 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.