Zustelldienst: Fehlercode (UUID) in HTTP Problem Details
Warum?
Um Fehler im Support besser nachvollziehen zu können, soll beim Auftreten eines Fehlers eine eindeutige UUID erzeugt werden, die sowohl in der HTTP-Response der Submission API enthalten ist, als auch geloggt wird. Nutzer:innen können anschließend bei Anfragen an den Support die UUID mitgeben, sodass durch den Support eine Zuordnung zu weiteren Einträgen im Log stattfinden kann.
Relevante Links und Bemerkungen
Beispiel:
{
"type": "https://schema.fitko.de/fit-connect/submission-api/problems/bad-request",
"title": "Internal Server Error",
"status": 500,
"detail": "Unknown Error",
"errorcode": "135851f0-f2d5-4cd5-b9af-d20e0943396b"
}
Akzeptanzkriterien
-
Prüfen ob das nicht bereits umgesetzt ist -
Ein Fehler wird immer mit dem errorcode
an die Nutzer zurückgegeben (offene Frage: ist UUID hier die richtige Wahl) -
errorcode
wird auch geloggt, so dass dieser vom Support gefunden werden kann
Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)
-
... -
... -
... -
Definition of Done wurde geprüft
Edited by Wojciech Gdaniec