Skip to content

Angabe der Version des Metadatenschemas in der Instanz der Metadaten (optionales `$schema`-Attribut)

Warum?

Als empfangendes System biete ich mehrere Versionen des Metadatenschemas in meinem Zustellpunkt an. Wenn ich eine Einreichung empfange, möchte ich eine Schemaprüfung des Metadatensatzes durchführen. Dafür möchte ich wissen, welche Version des Metadatenschemas verwendet wurde.

Relevante Links und Bemerkungen

  • Mit der nächsten Major-Version wird dieses Feld verpflichtend gesetzt. Hierzu gibt es ein passendes Issue: #572
  • Anpassung in den SDKs erfolgt in #775 (closed) und #776 (closed)

Akzeptanzkriterien

  1. Das Metadatenschema wird um ein Feld $schema erweitert, dass die URI des Metadatenschemas enthält
  2. Neu: Für das Attribut $schema sind nur Werte mit Regex "^https:/\\/schema\\.fitko\\.de\\/fit-connect\\/metadata\\/1\\.\\d+\\.\\d+\\/metadata\\.schema\\.json$" erlaubt (vgl. event-payload!5 (diffs))
  3. Das Feld und seine Verwendung ist dokumentiert -> wird behandelt in #133
  4. Neu: Für das Metadatenschema 1.0.0 wird in der Dokumentation empfohlen, dass eine $schema Property mit dem Wert https://schema.fitko.de/fit-connect/metadata/1.0.0/metadata.schema.json verwendet wird.
  5. Neu: Die Prüfung von Schemata gegen Beispiel-Payloads erfolgt automatisiert via GitLab-CI
  6. Die neue Version des Metadatenschemas wurde nach dem PO-Review veröffentlicht.
  7. Changelog in docs.fitko.de/fit-connect ergänzen
  8. Neue Version des Metadatenschemas 1.1.0 ist im Self-Service-Portal hinterlegt -> #1012 (closed)
  9. Neu: Das im Java-SDK hinterlegte Metadatenschema wurde auf die neue Version 1.1.0 aktualisiert.
  10. Neu: Das im .NET-SDK hinterlegte Metadatenschema wurde auf die neue Version 1.1.0 aktualisiert.

Durchführungsplan

  • Property $schema als enum mit einem fixen Wert RegEx, der alle Versionen der Form 1.x.y akzeptiert, ergänzen
  • Doku prüfen und ggf. ergänzen
  • (Property $schema mit nächster Major-Version in required ändern - Achtung: Breaking Change -> #572)

Branches

Metadaten - 267 schema mandatory

Merge Requests:

sdk-dotnet!39 (merged)

Edited by Marco Holz