Add more documentation about API vs. App keys #118
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Issue #115 demonstrated how easy it is to get confused about API vs. application keys, so I’ve added some more documentation here about the difference as well as links to the official documentation about it (https://docs.datadoghq.com/account_management/api-app-keys/).
I’ve also added a custom
AuthorizationError
class with a more explanatory message (also with links to the docs), so people should see something more helpful in their console or logs, too. If you log the full object, you’ll see something like:I asked on Datadog’s Slack to see if there was any known way of differentiating between API and Application keys (so we could have a special case that tells someone they’ve mixed them up), but never got any responses. 🤷
As a side note, I kind of think we should remove the
appKey
option altogether. There are things it could be useful for (e.g. some fancy possibilities in #33), it doesn’t actually get used for anything right now, so I imagine it mostly just adds confusion.