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:
- Format-Prüfung:
$formatMUSS “RUML” sein (Regel FMT-03FMT-03$formatMUSS"RUML"sein.)$specVersionMUSS unterstützte Version sein (Regel FMT-04FMT-04$specVersionMUSS eine der Versionen sein, die dasenumvon$specVersionim Schema aufführt.,Regel FMT-09FMT-09 Ein Parser MUSS eine Datei akzeptieren, deren$specVersionseine 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.)
- 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: einNumbereine JSON-Zahl, einBooleanein JSON-Boolean, einDateTimeeindate-timenach RFC 3339, einEnumeiner der für das Feld definierten Werte, einObjectein JSON-Objekt, einArrayein JSON-Array.)
- 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 vonrulemap.nodesvorkommen.) - 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-08rulemap.nodesMUSS 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:
- Referenzielle Integrität von
$base: Die$base.idMUSS mit dermetadata.idder referenzierten Basis-RUML-Datei übereinstimmen, und$base.hashMUSS dem aktuellen Hash der Basis-Datei entsprechen (Regel CAP-24CAP-24 Vor einem Merge MUSS$base.ideiner RUML-EXT-Datei gleichmetadata.idder Basis-RUML-Datei sein und ihr$base.hashgleich 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.). - 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 dennodeseiner RUML-EXT-Datei MUSS dieideines Knotens der Basis-RUML-Datei sein.).
Siehe Kapitel 4.5 für die vollständige RUML-EXT-Spezifikation.