Zum Inhalt springen
RUMLRUML

Open Format for Digital Law

2.6 Dateivalidierung

2.6 Datei-Validierung

Die Struktur einer RUML-Datei definiert das JSON Schema ruml.schema.json (Draft 2020-12).

Beim Laden einer RUML-Datei MUSS:

  1. Format-Prüfung:
  • $format MUSS “RUML” sein (Regel FMT-03FMT-03 $format MUSS "RUML" sein.)
  • $specVersion MUSS unterstützte Version sein (Regel FMT-04FMT-04 $specVersion MUSS eine der Versionen sein, die das enum von $specVersion im Schema aufführt., Regel FMT-09FMT-09 Ein Parser MUSS eine Datei akzeptieren, deren $specVersion seine eigene MAJOR-Version und eine MINOR-Version bis zu seiner eigenen hat, und MUSS eine Datei mit einer höheren MINOR-Version oder einer anderen MAJOR-Version ablehnen.)
  1. Struktur-Prüfung:
  • Alle Pflichtfelder MÜSSEN vorhanden sein
  • Datentypen MÜSSEN den Spezifikationen aus Kapitel 3.2 entsprechen (Regel FMT-13FMT-13 Jeder Feldwert MUSS den Datentyp haben, den 3.2.3 ihm zuweist: ein Number eine JSON-Zahl, ein Boolean ein JSON-Boolean, ein DateTime ein date-time nach RFC 3339, ein Enum einer der für das Feld definierten Werte, ein Object ein JSON-Objekt, ein Array ein JSON-Array.)
  1. Hash-Verifikation (nur bei Verwendung des Container-Formats):
  • Hash-Prüfung erfolgt auf Container-Ebene (siehe Kapitel 7)
  • Bei vorhandenem Hash MUSS dieser verifiziert werden; bei Abweichung MUSS die Verarbeitung verweigert werden

Identifikator-Prüfung:

  • LexIDs MÜSSEN eindeutig sein; ein wiederverwendeter modularer Knoten hat genau einen nodes-Eintrag (Regel FMT-12FMT-12 Eine LexID DARF NICHT mehr als einmal als Schlüssel von rulemap.nodes vorkommen.)
  • UUIDs MÜSSEN dem Pattern entsprechen (Regel FMT-10FMT-10 Jede UUID MUSS eine kleingeschriebene UUID der Version 4 sein (Muster in 2.5).)
  • Das nodes-Objekt MUSS einen Eintrag mit Key "1" (Root-Node) enthalten (Regel FMT-08FMT-08 rulemap.nodes MUSS einen Eintrag mit dem Schlüssel "1" enthalten, den Root-Knoten.)

Validierung von RUML-EXT-Dateien

Beim Laden einer RUML-EXT-Datei (.ruml-ext, $format: "RUML-EXT") MUSS ein Validator zusätzlich prüfen:

  1. Referenzielle Integrität von $base: Die $base.id MUSS mit der metadata.id der referenzierten Basis-RUML-Datei übereinstimmen, und $base.hash MUSS dem aktuellen Hash der Basis-Datei entsprechen (Regel CAP-24CAP-24 Vor einem Merge MUSS $base.id einer RUML-EXT-Datei gleich metadata.id der Basis-RUML-Datei sein und ihr $base.hash gleich dem Hash der kanonischen Form der Basis-RUML-Datei; andernfalls MUSS der Parser den Merge abbrechen. Jede RUML-EXT-Datei wird für sich geprüft.).
  2. UUID-Existenz: Jede UUID im nodes-Objekt der EXT-Datei MUSS in der Basis-RUML-Datei existieren. UUIDs ohne korrespondierende Knoten in der Basis-Datei MÜSSEN als Fehler behandelt werden (Regel CAP-26CAP-26 Jede Knoten-UUID in den nodes einer RUML-EXT-Datei MUSS die id eines Knotens der Basis-RUML-Datei sein.).

Siehe Kapitel 4.5 für die vollständige RUML-EXT-Spezifikation.