Einheitliche Darstellung JWT/JWS in Spec
Warum?
(Diese Story ist ein Follow-Up Task aus dem API-Spec Review: #47 (closed))
Als Entwickler möchte ich, dass in der API identische Konzepte auf die gleiche Weise dargestellt werden. Aktuell werden aber in der Submission Base 64 codierte JWT/JWS, sodass als Entwickler unklar entstehen, warum diese identischen Konzepte unterschiedlich dargestellt werden.
Diese Situation sorgt dafür, dass aufgrund von Unklarheiten Nachfragen zu API-Spezifikation entstehen und Fehler in der Implementierung gemacht werden. Um ein einheitliches Verständnis der API zu erreichen und weitere Unklarheiten bei Entwicklern zu vermeiden, soll die Darstellung von JWT/JWS vereinheitlicht werden.
Relevante Links und Bemerkungen
Ergebnisse aus dem Review:
-
https://docs.fitko.de/fit-connect/docs/apis/submission-api#get-/submissions/-submissionId-/attachments/-attachmentId- Attachment ist ein Base64 codierter JWE/JWT und wird als ": string" mit entsprechenden Regex Patern und application/jose dargestellt.
-
https://docs.fitko.de/fit-connect/docs/apis/submission-api#put-/submissions/-submissionId-/attachments/-attachmentId- Hier ist das gleiche Attachment ein leeres Objekt mit Application Type application/jose.
-
https://docs.fitko.de/fit-connect/docs/apis/submission-api#post-/submissions/-submissionId-/event Das Event ein Base64 codiertes JWS/JWT und wird als application/octet-stream dargestellt.
Akzeptanzkriterien
-
JWT sind einheitlich in der ganzen API spezifiziert. Hierbei sollte einer der existierenden Varianten genutzt werden.
Durchführungsplan
-
API-Spec anpassen. -
API-Spec Review durchführen. -
API als Patch Release veröffentlichen. -
Änderung in den Zustelldienst überführen -
Zustelldienst in dev ausrollen -
Zustelldienst in testing ausrollen