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

Error Standardization: Cryptography API #7491

Open
5 tasks
cicoyle opened this issue Feb 2, 2024 · 2 comments · May be fixed by #7558
Open
5 tasks

Error Standardization: Cryptography API #7491

cicoyle opened this issue Feb 2, 2024 · 2 comments · May be fixed by #7558
Assignees
Labels
good first issue Good for newcomers

Comments

@cicoyle
Copy link
Contributor

cicoyle commented Feb 2, 2024

Richer errors in Dapr for the Cryptography API.

Note: Please clone this issue and assign the clone of this issue to yourself if you would like to contribute to the error standardization efforts.

Scope of work

  • Choose 5-10 errors in the Cryptography API to enrich. Ideally, cover as many errors as possible from the API.
  • Follow the steps outlined in this README for each error being updated

Definition of done

  • Update 5-10 errors in the Cryptography API
  • Update the unit tests, if necessary
  • Write integration tests to cover each updated errors

Keep in mind

Unless a major version is being released and there is a solid reason for introducing backwards incompatibility, we can't change the API, meaning the HTTP and gRPC status codes, and the error codes must stay the same. An exception to this is the gRPC StatusCode.UNKNOWN which should be converted to a specific status.

See the kit errors pkg README for another usage example. For each error being updated, you can use the following helper functions to add error details, see the kit errors pkg for more details:

  • WithHelpLink()
  • WithHelp()
  • WithErrorInfo() - Required
  • WithFieldViolation()
  • WithDetails()

Reference PRs

Existing error standardization for:

@cicoyle cicoyle added the good first issue Good for newcomers label Feb 2, 2024
@chaitanyab2311
Copy link

/assign

@chaitanyab2311
Copy link

/assign

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue Good for newcomers
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants