JSON Schema Konverter: Vergleich mit bestenden Konvertern
Warum machen wir das?
Der für das Schema-Repository entwickelte Schema-Konverter soll mit andern bestehenden XDatenfeld-Konvertern verglichen und ggf. optimiert werden. Ziel ist, eine hohe Qualität des im Schema-Repository eingesetzten Konverters sicherstellen zu können. Dies erfordert ggf. auch eine Beschreibung der spezifischen Konvertierungsregeln.
Relevante Informationen
Insgesamt sind derzeit drei Konverter bekannt, die XDatenfelder nach JSON-Schema konvertieren können:
- Der Schema-Konverter aus dem Projekt FIT-Connect, deployed unter https://schema-converter.fitko.dev/, bespielt auch https://schema.fitko.de/fim/
- Der Schema-Konverter von Lilith Wittmann namens ozg
- Der Schema-Konverter aus dem Projekt Schema-Repository, deployed unter https://test.schema-repository.fitko.dev/services/xdf2-json-schema-converter
Die Konvertierungsregeln des im Projekt FIT-Connect entstandenen Schema-Konverters sind im Dokument Ableitung von JSON Schema aus FIM Stammdatenschemata beschrieben.
Der Schema-Konverter ozg macht einige Dinge unterschiedlich zu unserem Konverter. Wir sollten schauen, was konkret anders gemacht wird, und was auch bei fuer uns Sinn ergibt. Ein konkretes Beispiel ist die Verwendung von oneOf statt enum, was bei select Datenfeldern auch die Angabe der Labels erlaubt (Vergleich hier). Wichtig: Offene MRs mitbetrachten.
Die Qualität erzeugter JSON-Schema kann mit Hilfe von https://rjsf-team.github.io/react-jsonschema-form/ manuell analysiert werden.
Akzeptanzkriterien
-
Aus allen verfügbaren XDatenfeld-Dateien wurden einige Dateien für manuelle Tests ausgewählt. Dabei wurden mögliche Edge-Cases und Fehlerquellen aufgrund der in den XDatenfeld-Dateien verwendeten Features berücksichtigt. -
Anhand von beispielhaft gewählten XDatenfeld-Dateien wurden die Ergebnisse der drei bekannten Schema-Konverter verglichen. Unterschiedliche Resultate wurden hinsichtlich ihrer Geeignetheit bewertet. -
Anpassungsbedarfe im Schema-Konverter aus dem Projekt Schema-Repository sind in Form von Follow-Up-Issues dokumentiert. -
[ggf.] Dokument Ableitung von JSON Schema aus FIM Stammdatenschemata wurde in die FIM-Dokumentation (https://docs.fitko.de/fim/) übernommen und entsprechend den tatsächlichen Konvertierungsregeln des im Schema-Repository genutzten Konverters angepasst.
Durchführungsplan
-
... -
... -
...