microsoft / microsoft/api-guidelines
[Azure REST API Guidelines] Provide a default table of generic error codes for usage errors
Nobody has claimed this yet.
- Dominant language
- No language data
- Stars
- 23.3k
- Forks
- 2.7k
- PR merge metrics
- No merged PRs in 30d
Description
We should provide a suggested starting point for common error code values in the Considerations for Service Design doc. I've often pointed other services at Storage for an example (Common, Blobs, Queues, Files, Tables), but it would be even more helpful to have a generic table that's not specific to any service. Imagine something like:
| Status Code | Error Code | Error Message |
|---|---|---|
400 |
InvalidValue |
The value provided for the [query parameter/header/property/etc.] [name] was invalid. [Details about what was invalid and how to fix.] |
400 |
MissingRequiredValue |
The required [query parameter/header/property/etc.] [name] was not specified for this request. |
403 |
AuthenticationFailed |
Server failed to authenticate the request. Make sure the value of the Authorization header is valid. |
| ... | ... | ... |
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with azure/ConsiderationsForServiceDesign.md and review the linked Storage error-code references for patterns that can be generalized across services. Add a generic table of status codes, error codes, and messages for common usage errors; done means the guidance is service-neutral and includes actionable message templates.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100