Vereinheitlichung Responses für POST/PUT Submissions
Warum?
(Diese Story ist ein Follow-Up Task aus dem API-Spec Review: #47 (closed))
Aktuell werden für POST /v1/submissions und PUT /v1/submissions/{submissionId} unterschiedliche Responses zurückgesendet. Prinzipiell liegen identische Informationen nach dem POST und PUT vor, sodass die Responses identischer aufgebaut werden könnten. Hierdurch wird das Verständnis der API Spec vereinfacht.
Relevante Links und Bemerkungen
- Submission API: https://docs.fitko.de/fit-connect/docs/apis/submission-api/
- Auch die umgesetzte API Version in ZSD aktualisieren: https://git.fitko.de/fit-connect/zustelldienst/blob/main/src/main/resources/application.yml#L133
Akzeptanzkriterien
-
Bei POST /v1/submissionswird die gleiche Antwort (mit Ausnahmen, s.u.) wie beiPUT /v1/submissions/{submissionId}zurückgegeben. -
Bei POST /v1/submissionsmacht nur ein leeresattachmentsArray Sinn, da dieses Array die bereit hochgeladenen Attachments darstellt. -
Bei beiden Endpunkten sollen attachments, ~~announcedAttachments~~ undserviceTypezurückgegeben werden. (Anmerkung 17.4:announcedAttachmentssoll nach Abstimmung gar nicht zurückgegeben werden.) -
Ausnahme: Das Feld callbacksoll beim EndpunktPOST /v1/submissionsnicht zurückgegeben werden, da es beim PUT Endpunkt schon deprecated ist. -
Das Release der neuen API-Version ist ein Minor-Change, da hier nur zusätzliche Datenfelder zurückgegeben werden.
Durchführungsplan
-
... -
... -
...
Follow-Up
-
prüfen ob announcedAttachmentsgrundsätzlich inattachmentsbeiPOST /v1/submissionsumbenannt wird (Zweck: Vereinheitlichung und Durchgängigkeit)
Edited by Hendrik Kamp