Versenden von Einreichungen (Submissions) ohne Fachdaten nicht mehr erlauben (required `encryptedData`) [Open Code #20]

Warum?

Submissions und Replies ohne maschinenlesbare Fachdaten sollen nicht mehr unterstützt werden. Um das Ziel der effizienteren Digitalisierung durch Maschinenlesbarkeit zu fördern, wollen wir keine Submissions und Replies zulassen, die nur (PDF-)Anhänge enthalten.

Die Submission API, das Metadatenschema, SET-Payload-Schema und die Dokumentation sollen angepasst werden, sodass eine Einreichung ohne Fachdatensatz nicht mehr möglich ist.

Relevante Links und Bemerkungen

Für die Implementierung der replies wurde die Entscheidung getroffen, dass Fachdaten (encryptedData) ein Pflichtfeld sind.

An den Zustellpunkten in der Submission API ist die URI eines Fachdatenschemas ein Pflichtfeld: https://docs.fitko.de/fit-connect/docs/apis/submission-api/#get-/v1/destinations

Im Metadaten-Schema sind die Fachdaten optional: https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json

Beim Einreichen (https://docs.fitko.de/fit-connect/docs/apis/submission-api/#put-/v1/submissions/-submissionId-) und Abholen (https://docs.fitko.de/fit-connect/docs/apis/submission-api/#get-/v1/submissions/-submissionId-) sind die verschlüsselten Fachdaten ebenfalls optional.

Sowohl in der Spezifikation der Absenderseite als auch im Kapitel Sicherstellen der Integrität einer Submission auf der Seite "Einreichung überprüfen" sind die Fachdaten als optional beschrieben. Auch in den Schemas (AuthenticationTags, SubmitSubmission-Event) sind die für die Fachdaten relevanten Felder optional.

Auf der gleichen Seite gibt es aber auch ein Abschnitt Fachdatensatz, nach dem der Fachdatensatz als Pflichtfeld geprüft werden soll.

Akzeptanzkriterien

1. Es gibt einen Test, der prüft, dass Submissions ohne encryptedData unzulässig ist. (-> siehe Klasse ApiSubmitSubmission)
2. Es wird auf Stage/Prod vorher geprüft, ob bestehende Implementierungen von OD/DV brechen.
3. Dokumentation ist angepasst (#451 (closed))
4. #1326 (closed) ist in dem Zuge auch umgesetzt

Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)

• https://gitlab.opencode.de/fitko/feedback/-/issues/20 bescheid geben nach Implementierung
• ...
• ...
• Definition of Done wurde geprüft

added component::Submission-API major-api-change labels

changed milestone to %Story und Task Kandidaten für Q3 2022

Betrifft FCONSD-168

siehe auch: https://gitlab.opencode.de/fitko/feedback/-/issues/20

added Epic::ZSD-Refactoring label

changed milestone to %Backlog

changed the description

added type::Story label

added workflow::Backlog label

added team::ZSD label

marked this issue as related to #451 (closed)

changed the description

changed title from Versenden von Einreichungen ohne Fachdatenschema nicht mehr erlauben to Versenden von Einreichungen (Submissions) ohne Fachdaten nicht mehr erlauben{+ (required encryptedData)+}

mentioned in issue #1290 (closed)

marked this issue as related to #1290 (closed)

changed the description