Skip to content

[v2] HTTP response codes vereinheitlichen

Begründung

  1. Unter PUT /submissions/id wird im Erfolgsfall derzeit HTTP 202 zurückgegeben. Dies ist auf eine Fehlinterpretation des HTTP-Standards zurückzuführen und sollte hin zu 200 geändert werden.
  2. POST-Requests zum Anlegen von "Ressourcen" sollten HTTP 201 zurückgeben und (neben der Response-Payload) auch einen Location-Header beinhalten. Der Location-Header fehlt bei POST /replies und POST /submissions.
  3. Alle unsere Endpunkte haben inkonsistente Blöcke von Fehler-Responses definiert, die jeden HTTP Status Code einzeln ausweisen, aber auf dasselbe Schema für den Response-Body verweisen. Dies ist nicht nur redundant und erzeugt viel Duplikation, es ist auch nie vollständig. De facto kann fast jeder Status-Code aus der 4xx-Reihe erzeugt werden. Es wäre besser, stattdessen responses.default zu beschreiben, dass alle 4xx Codes auftreten können und dass diese alle demselben Fehler-Schema folgen.

Akzeptanzkriterien

  • PUT /submissions/id gibt HTTP 200 zurück
  • POST /replies und POST /submissions geben einen Location-Header zurück.
  • Alle Endpunkte verwenden statt des Fehler-Response-Blocks nur einen Eintrag unter responses.default.
Edited by Fabian Sudau