| Summary: | Add supported authentication methods documentation | ||
|---|---|---|---|
| Product: | Koha | Reporter: | Tomás Cohen Arazi (tcohen) <tomascohen> |
| Component: | REST API | Assignee: | Tomás Cohen Arazi (tcohen) <tomascohen> |
| Status: | CLOSED FIXED | QA Contact: | Martin Renvoize (ashimema) <martin.renvoize> |
| Severity: | enhancement | ||
| Priority: | P5 - low | CC: | dcook, jonathan.druart, kyle, martin.renvoize, nick |
| Version: | Main | ||
| Hardware: | All | ||
| OS: | All | ||
| Change sponsored?: | --- | Patch complexity: | --- |
| Documentation contact: | Documentation submission: | ||
| Text to go in the release notes: | Version(s) released in: |
21.11.00
|
|
| Circulation function: | |||
| Attachments: |
Bug 28412: Add information about supported authentication methods
Bug 28412: Add information about supported authentication methods Bug 28412: Add information about supported authentication methods |
||
|
Description
Tomás Cohen Arazi (tcohen)
2021-05-21 11:52:38 UTC
Created attachment 121462 [details] [review] Bug 28412: Add information about supported authentication methods This patch adds an initial text explaining the valid authentication mechanisms Koha has for the API. My first approach included information about the controlling sysprefs, but I decided to remove it, as it is not usual for API consumers to be presented such detailed internal information which is probably confusing. We could add a link to the manual, but that's not the point I think. I've added an entry about error messages and how we thougth about them. It is copied from Docker Engine's API docs. This is my 2 cents. Created attachment 124581 [details] [review] Bug 28412: Add information about supported authentication methods This patch adds an initial text explaining the valid authentication mechanisms Koha has for the API. My first approach included information about the controlling sysprefs, but I decided to remove it, as it is not usual for API consumers to be presented such detailed internal information which is probably confusing. We could add a link to the manual, but that's not the point I think. I've added an entry about error messages and how we thougth about them. It is copied from Docker Engine's API docs. This is my 2 cents. Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Created attachment 124657 [details] [review] Bug 28412: Add information about supported authentication methods This patch adds an initial text explaining the valid authentication mechanisms Koha has for the API. My first approach included information about the controlling sysprefs, but I decided to remove it, as it is not usual for API consumers to be presented such detailed internal information which is probably confusing. We could add a link to the manual, but that's not the point I think. I've added an entry about error messages and how we thougth about them. It is copied from Docker Engine's API docs. This is my 2 cents. Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com> Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com> Pushed to master for 21.11, thanks to everybody involved! |