Schema-Konverter als Bibliothek oder Service bereitstellen [Open Code #12]
Warum?
Für Tests mit eigenen Schemas sollen Entwicker:innen bereits vor Freigabe von Fachdatenschemata in die Lage versetzt werden, XDatenfelder-Dokumente in JSON-Schemas zu konvertieren.
Zusätzlicher Bedarf des FIM-Editor: Der FIM-Editor soll JSON-Schemas exportieren können. Daher muss eine Möglichkeit gefunden werden, wie die Konvertierung nicht nur in der GitLab CI sondern auch dort stattfinden kann.
Relevante Links und Bemerkungen
- Erste Vorarbeiten finden sich hier: https://git.fitko.de/fit-connect/fim-schema-converter
- Derzeit erzeugt der Schema-Konverter nur ein JSON Schema und noch kein XML Schema. Der Code ist auch eher noch PoC und wir hatten überlegt, den Java und Shell-Code zu einem Python-Tool zu konvertieren.
- Unter https://github.com/LilithWittmann/ozg findet sich eine XDatenfelder-Library, die XDatenfelder-Dokumente nach JSON-Schema konvertieren kann.
Akzeptanzkriterien
-
Der Konverter ist in der Lage .xsd
s zu erzeugen (sog. "XFall Schema") -
Der Konverter ist in der Lage JSON-Schema zu erzeugen. -
Der Schema-Konverter steht als öffentliches Repository zur Verfügung. -
Die REUSE-Spezifikation wird eingehalten. -
Es existiert eine README mit allgemeinen Infos + Lizenzinformationen + Verweis auf Doku. -
Die Nutzung des Tools ist (in der Readme oder in der FIT-Connect-Dokumentation) beschrieben. -
In der FIT-Connect-Dokumenation wird auf den Schema-Konverter hingewiesen
Durchführungsplan (von Entwickler:in bei Umsetzungsplanung auszufüllen)
-
https://gitlab.opencode.de/fitko/feedback/-/issues/12 wurde benachrichtigt -
... -
... -
Definition of Done wurde geprüft
Edited by Laura Elges