microsoft / microsoft/api-guidelines
Align error responses with ProblemDetails specification (RFC 7807) ?
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Keine Sprachdaten
- Sterne
- 23.3k
- Forks
- 2.7k
- PR-Merge-Kennzahlen
- Keine gemergten PRs in 30 T.
Beschreibung
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.
Beitragsleitfaden
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Vergleiche den Abschnitt der Microsoft API Guidelines zu Antworten auf Fehlerbedingungen mit RFC 7807 und der verlinkten Ankündigung zu ASP.NET Core 2.2 ProblemDetails. Ermittle, ob die Richtlinie an RFC 7807 ausgerichtet werden sollte, und dokumentiere die geklärte Position sowie alle erforderlichen Änderungen an der Richtlinie.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Bereich
- api, documentation
- Issue-Typ
- Dokumentation
- Schwierigkeit
- 5/5
- Geschätzter Aufwand
- Über eine Woche
- Aktivitätsstatus
- Veraltet
- Klarheit
- Muss geklärt werden
- Anfängerfreundlichkeit
- 25/100