dapr icon indicating copy to clipboard operation
dapr copied to clipboard

[Clone] Error Standardization: Secrets API

Open yanleiwang opened this issue 1 year ago • 1 comments

Original https://github.com/dapr/dapr/issues/7484

Richer errors in Dapr for the Secrets 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 Secrets 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 Secrets 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:

yanleiwang avatar Oct 17 '24 16:10 yanleiwang

/assign

yanleiwang avatar Oct 17 '24 16:10 yanleiwang

This issue has been automatically marked as stale because it has not had activity in the last 60 days. It will be closed in the next 7 days unless it is tagged (pinned, good first issue, help wanted or triaged/resolved) or other activity occurs. Thank you for your contributions.

dapr-bot avatar Dec 16 '24 16:12 dapr-bot

This issue has been automatically closed because it has not had activity in the last 67 days. If this issue is still valid, please ping a maintainer and ask them to label it as pinned, good first issue, help wanted or triaged/resolved. Thank you for your contributions.

dapr-bot avatar Dec 23 '24 17:12 dapr-bot