[v2] Metadatensatz modularisieren - Basis
User Story
Die Informationen im Metadatensatz kommen aus verschiedenen Quellen. Um der untersciedlichen Herkunft und Empfänger Rechnung zu tragen, sollte der Metadatensatz in mehrere kleinere Datensätze zerteilt werden. Der Metadatensatz sollte auch leichter erweiterbar werden.
Mit dieser Story soll die Modularisierung vorbereitet werden:
- Auf der obersten Ebene wird ein Array
dataSets
hinzugefügt, dass eine Liste von Datensatz-Objekten enthält. - Das Objekt
additionalReferenceInfo
bleibt (vorerst) unverändert, es ist jedoch nicht mehr zulässig, über die definierten Inhalte hinaus individuelle Felder und Objekte dort hinzuzufügen. Bei Bedarf ist für individuelle Daten eindataSet
zu verwenden, dessen Schema vom Sender bereitzustellen ist. - Das Objekt
authenticationInformation
wird entfernt und durch ein dataSet mit externem Schema (https://raw.githubusercontent.com/Governikus/IdentificationReport/2.0.0/schema/identification-report.json) ersetzt. - Das Objekt
paymentInformation
wird erst deprecated, wenn die Bereitstellung eines SChemas für das DataSet geklärt ist.
Warum
Das Objekt additionalReferenceInfo
ist derzeit problematisch, weil es sowohl spezifizierte Daten enthält als auch für individuelle Daten offen steht.
Links, Hinweise, Bemerkungen
Akzeptanzkriterien
-
Auf der obersten Ebene gibt es ein Array dataSets
, dass eine Liste von Datensatz-Objekten enthält. -
Das Objekt additionalReferenceInfo
bleibt (vorerst) unverändert, es ist jedoch nicht mehr zulässig, über die definierten Inhalte hinaus individuelle Felder und Objekte dort hinzuzufügen. -
Es ist dokumentiert, dass für individuelle Daten eindataSet
zu verwenden ist, dessen Schema der Sender bereitzustellen hat. -
Das Objekt authenticationInformation
wurde entfernt. -
Das anstelle dessen eingeführte DateSet mit Schemahttps://raw.githubusercontent.com/Governikus/IdentificationReport/2.0.0/schema/identification-report.json
wird in der Dokumentation referenziert bzw. dessen Verwendung wird beschrieben.
Mögliche Folgeaktivitäten (vom Entwickler zu ergänzen)
-
... -
... -
... -
Dokumentation in der Betriebsdokumentation -
Definition of Done was checked.
Edited by Andreas Aschauer