Skip to content

Dokumentation: Überarbeitung der Seite "Fehlerverhalten und Statuscodes" [Open Code #18]

Überarbeitung der Seite Fehlerverhalten und Statuscodes

  • Der Abschnitt "Features" ist unverständlich. Hier fehlt noch etwas Erklärungstext.
  • Beschreibungen der Fehler fehlen weitgehend
  • Fehler soll zukünftig direkt in der API-Spezifikation im jeweiligen Endpunkt dokumentiert werden (als Markdown im desciption-Attribut der Response des Endpunktes)
  • Alle Fehler, die aktuell durch die API herausgegeben werden, müssen hier dokumentiert werden (Siehe bspw. security-event-token-validation aus #244 (comment 16482) )
  • Die Unterscheidung zwischen Problem-Types der APIs (Submission API, Routing API) und aus den Events wird erklärt, insbes. was die Fehler der Destination-API betrifft.
    • https://schema.fitko.de/fit-connect/submission-api/problems/... beschreibt Problem-Types aus der Submission API
    • https://schema.fitko.de/fit-connect/routing-api/problems/... beschreibt Problem-Types aus der Routing API
    • https://schema.fitko.de/fit-connect/events/problems/... beschreibt Problem-Types aus Events
  • Alle neuen Fehler-types, die durch die BiDiKo hinzugekommen sind (insb. Reply-spezifische), sind in der Dokumentation gelistet. (TODO: neues Issue hierzu anlegen)
  • Verweis auf https://docs.fitko.de/fit-connect/docs/sending/accept-reject#type

Akzeptanzkriterium

Edited by Andreas Aschauer