search

dydra / support

4 stars 1 forks source link

confusing 'API Authentication' link in docs #58

Open knoan opened 5 years ago

knoan commented 5 years ago

The 'API Authentication' entry in the docs sidebar used to link to a page describing how to use API keys for authentication, but it currently points to the top-level API docs.

It's not clear whether the behaviour is intended and, if that is indeed the case, how to use API keys for authentication or if they still supported.

Screenshot 2019-10-18 at 09 40 49

lisp commented 5 years ago

the section in the api documentation which describes the http request parameters includes an entry for the authentication key.

as an alternative, the http test suite (https://github.com/dydra/http-api-tests) demonstrates its use extensively. in brief, if the authentication header (or curl --user) specifies a password, but no user, that is taken to be the authentication key.