microsoft / microsoft/api-guidelines
Align error responses with ProblemDetails specification (RFC 7807) ?
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
ASPNET Core 2.2 implements ProblemDetails specification while Microsoft API Guidelines advises a different error structure to be served. Is the guideline supposed to align with RFC 7807 at some point or not necessarily? Having said that It also feels a bit awkward that the flagship http api framework from Microsoft is not following the Microsoft API Guidelines.
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
Compare the Microsoft API Guidelines section on error condition responses with RFC 7807 and the linked ASP.NET Core 2.2 ProblemDetails announcement. Determine whether the guideline should align with RFC 7807, and document the resolved position and any required guideline changes.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100