Bug 28412: Add information about supported authentication methods
authorTomas Cohen Arazi <tomascohen@theke.io>
Thu, 27 May 2021 20:02:35 +0000 (17:02 -0300)
committerJonathan Druart <jonathan.druart@bugs.koha-community.org>
Tue, 21 Sep 2021 18:22:57 +0000 (20:22 +0200)
commit870e3e8e161f6da998c1deae216d7fdf0d0490e7
tree96bca58280231b59cc2ba03e4bafd43d2bd56d73
parent9c2f4ed6bfe45619fbec20a7480ef26f606b5976
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>
Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
api/v1/swagger/swagger.yaml