[Epic] ZSD 2.0

Warum

Die Einführung jährlicher Major Releases im Herbst bietet die Möglichkeit, schon länger anstehende breaking Changes wie das Entfernen abgekündigter Bestandteile oder die Bereinigung von inhomogenen Bezeichnungen umzusetzen.

Ziel

Der Zustelldienst und v.a. seine APIs sollen sauber, transparent und gut wartbar gehalten werden.

Links, Hinweise, Bemerkungen

Stories

Reihenfolge entsprechend der Prio:

• Voraussetzung: API-Repositorys auf neue Major-Versionen vorbereiten #3369
• Voraussetzung: Setup des Zustelldiensts für die Unterstützung der neuen API-Major-Version #3370, darin ist auch enthalten: Unterstützung für Legacy Trailing-Slashes in Pfaden muss nicht mit übernommen werden, d.h. aus GET /v1/cases und GET /v1/cases/ wird nur GET /v2/cases
• /v2/info sollte die v2 Versionen der APIs liefern #3447
• GET destination in der Submission API nur noch als öffentlicher Endpunkt component::Submission-API #3319
• Metadaten v2
• Array submissionIds in den Webhooks optional component::Submission-API #3323
• Event forward-submission abkündigen / entfernen component::Submission-API #3420
• 'jwk.use' nicht mehr rausgeben component::Destination API component::Submission-API #3325
• Abgekündigtes Objekt 'Callback' nicht mehr ausgeben component::Submission-API #3326
• 'destination.replyChannels' auf Root-Ebene nicht mehr rausgeben und nicht mehr annehmen component::Destination API component::Submission-API #3328
• Vereinheitlichung serviceType vs. service vs. publicServiceType component::Destination API component::Submission-API #499
• Versenden von Einreichungen (Submissions) ohne Fachdaten nicht mehr erlauben (required encryptedData) component::Submission-API #322
• HTTP response codes vereinheitlichen #3428
• Kompression wird unterbunden #2849

Metadaten v2

• Metadatensatz modularisieren - Basis component:Metadatenschema #3320
• Zustimmung zum elektronischen Bescheid in den Metadaten component:Metadatenschema #3188
• Absenderinfo in den Metadaten component:Metadatenschema #3242
• $schema verpflichtend im Metadatensatz component:Metadatenschema #3452 bzw. #572
• finkPostfachRef`-RegEx erlaubt Übergabe eines leeren Strings component:Metadatenschema #1301

Akzeptanzkriterien

1. Der ZSD bietet die neuen Versionen der APIs parallel zu der jeweiligen letzten Version der v1 an.
2. Die Spezifikationen der neuen API-Versionen wurden erstellt, veröffentlicht und dokumentiert. #3400
3. ...
4. ...
5. Definition of Done wurde überprüft.

Mögliche Folgeaktivitäten

Offene Fragen