SolarArbiter / solarforecastarbiter-api

HTTP API and database schema for the Solar Forecast Arbiter
https://api.solarforecastarbiter.org
MIT License
10 stars 6 forks source link

authorization doc suggestions #303

Closed wholmgren closed 3 years ago

wholmgren commented 3 years ago

A few things to add to the authorization section since it confused at least one user.

The curl/jq example should make it clear that this is just one way of doing it. We could even start with plain HTTP and then provide the curl/jq example.

It might also be useful if we at least linked to request_cli_access_token function. Maybe even inline it.

https://github.com/SolarArbiter/solarforecastarbiter-core/blob/4e5808e5719bf5e60f1a79f5c92cf0f7576c4827/solarforecastarbiter/io/api.py#L35-L61

Next, we should provide more concrete guidance on how frequently to request a new token. Maybe change/move the sentence that starts with "A JWT will expire after a set period...". If I remember correctly, another user was rate limited by auth0 when trying to make a lot of requests, so we should include something about that too.

The sentence on access control could link to the relevant API sections and/or https://solarforecastarbiter.org/documentation/dashboard/administration/