Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document client errors #327

Open
3 tasks
alexkalish opened this issue Jun 8, 2021 · 0 comments
Open
3 tasks

Document client errors #327

alexkalish opened this issue Jun 8, 2021 · 0 comments

Comments

@alexkalish
Copy link

alexkalish commented Jun 8, 2021

I recently stumbled across the long list of error codes in the authn client here.

Two observations:

  1. These don't appear to all be errors. Some clearly are (e.g. "CAKC001 Error opening the access token file"), while others are simple informative log messages (e.g. "CAKC036 Logged in").
  2. Only two of these errors is actually documented in our official docs.

It's wonderful that we have so many known error conditions, but we could provide more benefit to users by fully documenting them.

AC:

  • Differentiate errors messages from informative log messages in the afore mentioned source file. Comments are fine. Mostly it should be obvious which are which, without having to look at use of the constant.
  • Minimally, document the root cause or trigger of each error so that they can go into official documentation. When possible, provide details for resolving/mitigating the error.
  • File a docs ticket to update the official docs with the info above. This content would be placed in the errors table referenced above.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

1 participant