08. Validierung
8.1 Übersicht
Dieses Kapitel ist der Katalog der Validierungsregeln für RUML-Dokumente. Jede Regel hat eine
stabile ID der Form <PRÄFIX>-<NN>; die Abschnitte gruppieren die Regeln nach Gegenstand, und
innerhalb eines Abschnitts sind sie nach ID sortiert. Implementierungen, Fehlermeldungen und
Testsuiten SOLLTEN diese IDs zitieren, statt den Regeltext zu wiederholen, damit sich ein Verstoß
unabhängig von Sprache und Formulierung identifizieren lässt.
Ein Parser MUSS ein Dokument ablehnen, das eine Regel dieses Katalogs verletzt. Eine Regel der Form
„Ein Parser MUSS … akzeptieren“ hält fest, was die Spezifikation erlaubt (DARF): Ein Parser, der ein
solches Dokument ablehnt, verletzt die Regel. Regeln der Ebene — binden das Werkzeug, das eine
Datei liest, schreibt oder auswertet; sie sind keine Eigenschaften der Datei.
Validierungsebenen
- Schema: Die Regel lässt sich allein durch Validierung des Dokuments gegen das RUML-JSON-Schema
prüfen. Dazu gehören die
format-Keywords des Schemas wiedate-time,uriundregex; ein Validator, der Formate nicht prüft, prüft diese Teile nicht. - semantisch: Die Regel braucht Logik über das Schema hinaus, etwa das Auflösen von Verweisen, den Vergleich von Werten oder die Eindeutigkeit im ganzen Dokument.
- —: Die Regel hängt vom Werkzeug ab, etwa von den Capabilities, die es implementiert, oder davon, wie es eine Datei schreibt, und lässt sich nicht allein am Dokument entscheiden.
Ein Validierungswerkzeug MUSS jede Regel der Ebenen Schema und semantisch prüfen (Regel CAP-28CAP-28 Ein Validierungswerkzeug MUSS jede Regel dieses Katalogs prüfen, deren Ebene schema oder semantic ist.).
Regel-IDs
Eine Regel-ID wird nie wiederverwendet. Eine zurückgezogene Regel behält ihre Zeile, markiert als Zurückgezogen, und ihre ID wird keiner anderen Regel gegeben.
JSON-Schema
Das JSON-Schema ist die normative Strukturdefinition des Formats. Es wird als Datei gepflegt und hier nicht wiederholt:
- Interaktiver Explorer: RUML JSON Schema
- Quelle:
schemas/ruml.schema.json(Draft 2020-12); RUML-EXT-Dateien werden gegenschemas/ruml-ext.schema.jsonvalidiert - Pakete:
@law-as-code-institute/ruml-schema(npm),ruml-schema(PyPI)
Die Spec-Version, die das Schema beschreibt, steht in seiner Annotation x-ruml-spec-version und
spiegelt den Wert $specVersion, den jede konforme Datei angeben MUSS.
8.2 Geltungsbereich
Dieser Katalog deckt das RUML-Dokument (.ruml) ab und die Pflichten der Werkzeuge, die es lesen,
schreiben und auswerten, einschließlich der Pflichten eines Parsers, der RUML-EXT-Dateien
verarbeitet (CAP-22 bis CAP-27). Er deckt nicht ab:
- die Ergebnisdatei
.ruml-result(Kapitel 5); - den RUML-Container, seine Hashes und Signaturen (Kapitel 7);
- die Anforderungen von Kapitel 4.5 an RUML-EXT-Dateien außer den Parser-Pflichten;
- den Vertrag eines Spec-Test-Runners (Anhang A).
Für ruml:draft/- und Reverse-Domain-Capabilities, die Erweiterungspunkte aus
Kapitel 4.1, deckt dieser Katalog ihre Deklaration und
Verwendung im Dokument ab – ID, role und required an der Root, wo und wie oft ein Eintrag stehen
darf und dass ein Knoten-Eintrag einen payload hat –, nicht aber den Inhalt des Payloads; den
legen der Parser und der Evaluator fest, die die Capability implementieren.
8.3 Regeln zum Dateiformat
Regeln abgeleitet aus Kapitel 2 und Kapitel 3.2.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
FMT-01 | 2.1, 3.2.3 | semantisch | Die Datei MUSS UTF-8-kodiert sein. |
FMT-02 | 2.1, 2.2, 3.8 | semantisch | Die Datei MUSS gültiges JSON sein (RFC 8259), und ihr Root-Wert MUSS ein Objekt sein. |
FMT-03 | 2.2, 2.6 | Schema | $format MUSS "RUML" sein. |
FMT-04 | 2.2, 2.3 | Schema | $specVersion MUSS eine der Versionen sein, die das enum von $specVersion im Schema aufführt. |
FMT-05 | 2.2 | semantisch | $format und $specVersion MÜSSEN die ersten beiden Felder des Root-Objekts sein. |
FMT-06 | 2.2 | Schema | Das Root-Objekt MUSS metadata und rulemap haben; ein Parser MUSS es mit und ohne capabilities akzeptieren. |
FMT-07 | 2.2 | Schema | Das Root-Objekt DARF KEINE anderen Felder als $format, $specVersion, metadata, capabilities und rulemap haben. |
FMT-08 | 2.2, 2.5, 2.6, 3.4.1, 3.5.1 | Schema | rulemap.nodes MUSS einen Eintrag mit dem Schlüssel "1" enthalten, den Root-Knoten. |
FMT-09 | 2.3, 2.6 | — | 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. |
FMT-10 | 2.5, 2.6, 3.5.2 | Schema | Jede UUID MUSS eine kleingeschriebene UUID der Version 4 sein (Muster in 2.5). |
FMT-11 | 2.5, 3.1, 3.5.3 | Schema | Jeder Schlüssel von rulemap.nodes und jeder Eintrag von children MUSS eine LexID sein, ein String, der ^[1-9][0-9]*$ entspricht. |
FMT-12 | 2.5, 2.6 | semantisch | Eine LexID DARF NICHT mehr als einmal als Schlüssel von rulemap.nodes vorkommen. |
FMT-13 | 2.6, 3.2.3, 3.8 | Schema | 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. |
FMT-14 | 3.2.6 | Schema | Ein DataPoint, Text-Eintrag oder Context-Eintrag DARF KEIN id-Feld haben; sein Schlüssel ist seine ID. |
8.4 Regeln zu Metadaten
Regeln abgeleitet aus Kapitel 3.3.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
META-01 | 3.3.1, 3.8 | Schema | metadata MUSS id, version, created, modified und status haben. |
META-02 | 3.3.1, 3.3.3 | Schema | status MUSS einer der sieben Werte aus 3.3.3 sein. |
META-03 | 3.3.1 | semantisch | modified DARF NICHT vor created liegen. |
META-04 | 3.3.2, 3.3.5 | Schema | Ein Parser MUSS jedes optionale Feld aus 3.3.2 und derivedFrom.originalHash akzeptieren, ob vorhanden oder nicht, auch replaces und replacedBy zusammen. |
META-05 | 3.3.2, 3.3.6 | Schema | documentType MUSS einer der Werte aus 3.3.6 sein. |
META-06 | 3.3.2 | Schema | authors MUSS mindestens einen Eintrag haben, und jeder Eintrag MUSS name haben. |
META-07 | 3.3.2 | semantisch | jurisdiction MUSS mit einem ISO-3166-1-Alpha-2-Ländercode beginnen; ein Parser MUSS danach bindestrichgetrennte Unterteilungen akzeptieren. |
META-08 | 3.3.2 | semantisch | language MUSS ein ISO-639-1-Code sein. |
META-09 | 3.3.2 | semantisch | Sind beide gesetzt, MUSS validUntil später als validFrom sein. |
META-10 | 3.3.3 | Schema | Status inForce MUSS validFrom gesetzt haben. |
META-11 | 3.3.3 | semantisch | Status expired MUSS validUntil gesetzt haben, und dieser Wert MUSS in der Vergangenheit liegen. |
META-12 | 3.3.3 | Schema | Status replaced MUSS replacedBy gesetzt haben. |
META-13 | 3.3.5 | Schema | derivedFrom MUSS originalId, originalStatus, derivationType und derivedAt enthalten. |
META-14 | 3.3.5 | semantisch | Eine Arbeitskopie (derivedFrom.derivationType: "workingCopy") DARF NICHT den Status inForce haben. |
8.5 Regeln zu Rulemap und Knoten
Regeln abgeleitet aus Kapitel 3.1, 3.4 und 3.5.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
NODE-01 | 2.2, 3.2.6, 3.5.2 | Schema | Ein Knoten MUSS id und label haben. |
NODE-02 | 3.1, 3.4.1 | Schema | rulemap MUSS nodes haben, ein Objekt, dessen Werte Knotenobjekte sind. |
NODE-03 | 3.1, 3.2.6, 3.5.1, 3.5.2 | Schema | Ein Knoten DARF KEINE anderen Felder als die aus 3.5 haben; insbesondere DARF er NICHT seine LexID (lexId), seinen Parent-Node oder seinen Typ speichern. |
NODE-04 | 3.1 | — | Ein Werkzeug, das eine Datei schreibt, MUSS die Reihenfolge jedes children-Arrays beibehalten. |
NODE-05 | 3.5.1 | semantisch | Der Root-Knoten "1" DARF in KEINEM children-Array vorkommen. |
NODE-06 | 3.5.1 | Schema | children DARF NICHT leer sein. |
NODE-07 | 3.5.2a, 3.5.3, 3.6, 3.6.4, 3.6.5 | Schema | Ein Parser MUSS die optionalen Knotenfelder aus 3.5.3 akzeptieren, ob vorhanden oder nicht, außer operator an einem Leaf-Node: Ein Leaf-Node DARF KEINEN operator haben, außer metadata.status ist draft; in einem Entwurf MUSS ein Parser jeden der acht Operatoren aus 3.6 an einem Leaf-Node akzeptieren. |
NODE-08 | 3.5.2, 3.8 | semantisch | Die id eines Knotens DARF NICHT gleich der id eines anderen Knotens oder metadata.id sein. |
NODE-09 | 3.5.2 | Schema | label DARF NICHT leer sein. |
NODE-10 | 3.5.3, 3.8 | semantisch | Jeder Eintrag von children MUSS ein Schlüssel von rulemap.nodes sein. |
NODE-11 | 3.5.3 | Schema | description DARF 10.000 Zeichen NICHT überschreiten. |
NODE-12 | 3.5.2a | Schema | Ein Knoten mit children MUSS operator haben. |
8.6 Regeln zu Operatoren
Regeln abgeleitet aus Kapitel 3.6.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
OP-01 | 3.5.2a | Schema | operator MUSS einer der acht Werte aus 3.6 sein. |
OP-02 | 3.6.4, 4.1, 4.3, 4.14 | semantisch | Außerhalb eines Entwurfs MUSS ein Knoten mit operator: "DELEGATED" children haben. Ein Knoten mit operator: "DELEGATED" und children MUSS genau einen Eintrag einer Capability mit der Rolle combiner haben; bei einer ruml:draft/- oder Reverse-Domain-Capability gilt die auf Root-Level deklarierte Rolle. In einem Entwurf MUSS ein Parser diesen Operator an einem Leaf-Node ohne Kombinierer akzeptieren (NODE-07). |
OP-03 | 3.6.4 | — | Ein Evaluator DARF einen Knoten mit operator: "DELEGATED" NICHT short-circuiten; er wertet jedes Kind aus, bevor der Kombinierer läuft. |
OP-04 | 3.6.4, 4.14 | semantisch | Die Node-Level-Payload eines Kombinierers MUSS eine nicht-leere description in Prosa haben. |
OP-05 | 3.6.4, 4.14 | semantisch | Ein Parser MUSS einen Kombinierer akzeptieren, der nicht-deterministische Eingaben verwendet, einschließlich einer ruml:expression, die $random, $now, $millis oder $eval aufruft. |
OP-06 | 3.6.4 | semantisch | Ein Parser MUSS jede auf Root-Level mit der Rolle combiner deklarierte Capability, auch eine Reverse-Domain-Capability, als Kombinierer eines DELEGATED-Knotens akzeptieren. |
OP-07 | 3.6.5 | Schema | operator: "undefined" DARF NICHT vorkommen, außer metadata.status ist draft; in einem Entwurf MUSS ein Parser ihn akzeptieren. |
8.7 Regeln zu Capabilities
Regeln abgeleitet aus Kapitel 4, einschließlich der Parser-Pflichten
für RUML-EXT-Dateien (4.5). Für diese ist das Schema
schemas/ruml-ext.schema.json.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
CAP-01 | 1.4, 4.1, 4.2 | semantisch | Ein Parser MUSS eine Datei ablehnen, die eine Capability mit required: true deklariert, die der Parser nicht implementiert, und DARF eine solche Datei NICHT teilweise verarbeiten. |
CAP-02 | 4.1, 4.2 | semantisch | Ein Parser MUSS eine Datei akzeptieren, die eine von ihm nicht implementierte Capability mit required: false oder ohne required deklariert, und MUSS die payload und die Einträge dieser Capability auf Node-Level ignorieren. |
CAP-03 | 4.1, 4.2, 4.4 | Schema | Der Root-Eintrag einer ruml:draft/- oder Reverse-Domain-Capability MUSS role deklarieren. |
CAP-04 | 4.1, 4.4 | semantisch | Ein Parser, der eine ruml:draft/- oder Reverse-Domain-Capability implementiert, MUSS die Datei ablehnen, wenn die deklarierte role von der Rolle abweicht, die er implementiert. |
CAP-05 | 4.1 | Schema | Der Root-Eintrag einer offiziellen ruml:-Capability DARF role NICHT deklarieren. |
CAP-06 | 4.1, 4.3 | semantisch | An einem Knoten DARF eine Capability mit der Rolle data NICHT mehr als einen Eintrag haben; ein Parser MUSS mehrere Einträge einer Capability mit der Rolle decision oder reaction akzeptieren. |
CAP-07 | 4.1, 4.3, 4.8, 4.16 | semantisch | Ein Eintrag einer Capability mit der Rolle decision DARF NICHT an einem Knoten mit children vorkommen. |
CAP-08 | 3.6.4, 4.1, 4.14 | semantisch | Ein Eintrag einer Capability mit der Rolle combiner DARF NICHT an einem Knoten vorkommen, dessen operator nicht DELEGATED ist. |
CAP-09 | 4.2 | Schema | Jeder Eintrag der Root-capabilities MUSS id haben; ein Parser MUSS darin required und payload akzeptieren. |
CAP-10 | 4.2 | semantisch | Eine id DARF NICHT mehr als einmal in den Root-capabilities vorkommen. |
CAP-11 | 4.2, 4.14 | Schema | Der Root-Eintrag von ruml:expression MUSS required: true haben. |
CAP-12 | 4.2 | semantisch | Das data der payload eines Root-Eintrags MUSS ein Objekt mit IDs als Schlüsseln sein; ein Parser MUSS eine payload mit data, config oder beidem akzeptieren, soweit die Capability sie vorsieht. |
CAP-13 | 4.2 | — | Ein Parser, der eine Capability implementiert, MUSS deren payload.data und payload.config gegen die Spezifikation dieser Capability validieren. |
CAP-14 | 4.2 | Schema | Ist das Root-capabilities nicht vorhanden oder leer, DARF ein Knoten NICHT capabilities haben. |
CAP-15 | 3.5.3, 4.2, 4.3, 4.8, 4.9, 4.15 | semantisch | Die id jedes Eintrags der capabilities eines Knotens MUSS in den Root-capabilities deklariert sein. |
CAP-16 | 4.3, 4.14 | Schema | Ein Parser MUSS capabilities an jedem Knoten akzeptieren und Einträge von Capabilities mit der Rolle data oder reaction an jedem Knoten, in beliebiger Reihenfolge, auch neben dem Kombinierer eines DELEGATED-Knotens. |
CAP-17 | 3.5.3, 4.3 | Schema | Jeder Eintrag der capabilities eines Knotens MUSS id und payload haben, und payload MUSS ein Objekt sein. |
CAP-18 | 4.3, 4.13 | Schema | ruml:protocol DARF NICHT in den capabilities eines Knotens vorkommen, weder inline noch in einer RUML-EXT-Datei. |
CAP-19 | 4.3 | Schema | Ein Parser MUSS decisionMode an einem Knoten mit children akzeptieren und MUSS es dort ignorieren. |
CAP-20 | 4.3 | — | Ein Werkzeug, das eine Datei schreibt, DARF die Einträge der capabilities eines Knotens NICHT umsortieren. |
CAP-21 | 4.4 | Schema | Eine Capability-ID MUSS eine von dieser Spezifikationsversion definierte ruml:-ID, eine ruml:draft/<name>-ID oder eine <reverse-domain>/<name>-ID sein; sie MUSS aus Kleinbuchstaben, Ziffern, _, - und den Trennzeichen bestehen und DARF 128 Zeichen NICHT überschreiten. |
CAP-22 | 4.5 | Schema | $format einer RUML-EXT-Datei MUSS "RUML-EXT" sein; ein Parser MUSS das prüfen, bevor er die Datei weiter verarbeitet. |
CAP-23 | 4.5 | Schema | Der Root einer RUML-EXT-Datei DARF NICHT metadata oder rulemap enthalten. |
CAP-24 | 2.6, 4.5 | semantisch | 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. |
CAP-25 | 4.5 | — | Ein Parser DARF den $base-Vergleich NICHT überspringen, auch nicht in einer Entwicklungsumgebung oder bei explizitem Benutzer-Override. |
CAP-26 | 2.6, 4.5 | semantisch | Jede Knoten-UUID in den nodes einer RUML-EXT-Datei MUSS die id eines Knotens der Basis-RUML-Datei sein. |
CAP-27 | 4.5 | semantisch | Dieselbe Capability DARF für denselben Knoten NICHT zugleich inline und in einer RUML-EXT-Datei definiert sein, auch nicht in zwei RUML-EXT-Dateien derselben Basis-RUML-Datei; ein Parser MUSS mehrere RUML-EXT-Dateien für eine Basis-RUML-Datei akzeptieren. |
CAP-28 | 4.6 | — | Ein Validierungswerkzeug MUSS jede Regel dieses Katalogs prüfen, deren Ebene schema oder semantic ist. |
CAP-29 | 4.8 | semantisch | Die ruml:query-Payload eines Knotens MUSS expression haben, einen gültigen JSONata-Ausdruck; ein Parser MUSS darin description akzeptieren. |
CAP-30 | 4.9 | Schema | Die ruml:ai-query-Payload eines Knotens MUSS model haben; ein Parser MUSS darin prompt, description, inputs und config akzeptieren. |
CAP-31 | 4.9 | Schema | Ein Parser MUSS context, dataPoints und texts in den inputs einer ruml:ai-query-Payload akzeptieren; ein Objekt-Eintrag von context MUSS id haben, und ein Parser MUSS darin role (reference oder subject) akzeptieren. |
CAP-32 | 4.9 | Schema | Ein Parser MUSS deterministic (ein Boolean), effort (low, medium oder high) und temperature (eine Zahl von 0 bis 1) im config der ruml:ai-query-Payload eines Knotens akzeptieren, sowie systemPrompt im config der Root-Level-Payload. |
CAP-33 | 4.9 | Schema | Ein Parser MUSS einen Leaf-Node akzeptieren, der sowohl ruml:query als auch ruml:ai-query hat. |
CAP-34 | 4.10 | Schema | Ein Parser MUSS ruml:actions an jedem Knoten akzeptieren, auch als dessen einzige Capability. |
CAP-35 | 4.10 | Schema | Die ruml:actions-Payload eines Knotens MUSS mindestens eines von onTrue, onFalse und onUndefined haben; eine Aktion MUSS operation und ref haben, und ein Parser MUSS description in der Payload, config in einer Aktion und jeden String als operation akzeptieren. |
CAP-36 | 4.13 | Schema | Ein Parser MUSS config.level mit dem Wert standard oder verbose in der Root-Level-Payload von ruml:protocol akzeptieren. |
CAP-37 | 4.14 | Schema | ruml:expression DARF NICHT in einer RUML-EXT-Datei vorkommen. |
CAP-38 | 4.14 | semantisch | Die ruml:expression-Payload eines Knotens MUSS eine nicht-leere expression haben, einen gültigen JSONata-Ausdruck. |
8.8 Regeln zu DataPoints
Regeln abgeleitet aus Kapitel 4.7.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
DP-01 | 4.7 | Schema | Ein DataPoint MUSS name, type und binding haben, und type MUSS einer der Datentypen aus 4.7.1 sein. |
DP-02 | 1.2, 4.7, 4.7.4 | Schema | Der Schlüssel eines DataPoints, die ID eines Sets und die Schlüssel der fields eines Sets MÜSSEN dem Muster [a-z_][a-z0-9_]* entsprechen. |
DP-03 | 4.7 | Schema | Ein Parser MUSS description, validation und sensitive an jedem DataPoint akzeptieren, unit bei number und percentage, format bei location, identifier und address sowie cardinality bei object. |
DP-04 | 4.7, 4.7.3 | Schema | Ein DataPoint DARF NICHT unit, format, options, set oder cardinality oder eine validation-Regel haben, die 4.7 und 4.7.3 für seinen Typ nicht vorsehen. |
DP-05 | 4.7, 4.7.1 | Schema | Ein DataPoint mit type: "currency" MUSS unit haben. |
DP-06 | 4.7, 4.7.1 | Schema | Ein DataPoint mit type: "enum" MUSS ein nicht-leeres options haben, und jede Option MUSS value haben. |
DP-07 | 4.7 | Schema | Ein DataPoint mit type: "object" MUSS set haben. |
DP-08 | 4.7, 4.7.3 | Schema | cardinality.min MUSS eine ganze Zahl von mindestens 0 sein und cardinality.max eine ganze Zahl von mindestens 1; minLength und maxLength MÜSSEN ganze Zahlen von 0 bis 253 − 1 sein. |
DP-09 | 4.7.2 | Schema | Ein Parser MUSS hint, placeholder und defaultValue in einem input-Binding akzeptieren, description, sourceType und fallback in einem external-Binding sowie description in einem computed-Binding. |
DP-10 | 4.7.2 | Schema | Ein external-Binding MUSS ref haben. |
DP-11 | 4.7.2 | semantisch | Ein computed-Binding MUSS expression haben, einen gültigen JSONata-Ausdruck; ein Parser MUSS einen Ausdruck akzeptieren, der andere DataPoints liest, auch berechnete. |
DP-12 | 4.7.2 | semantisch | Die Referenzen zwischen computed-DataPoints DÜRFEN KEINEN Zyklus bilden, weder direkt noch transitiv. |
DP-13 | 4.7.3 | Schema | validation.pattern MUSS ein gültiger regulärer Ausdruck nach ECMA-262 sein. |
DP-14 | 4.7.3 | Schema | validation.min und validation.max MÜSSEN den Typ haben, den 4.7.3 für den Datentyp angibt. |
DP-15 | 4.7.4 | Schema | Ein Eintrag von sets MUSS name und fields haben; ein Parser MUSS darin description akzeptieren und unter seinen fields einen DataPoint mit type: "object". |
DP-16 | 4.7.4 | semantisch | Das set eines DataPoints MUSS die ID eines Eintrags von sets sein. |
DP-17 | 4.7.4 | semantisch | Ein Set DARF sich NICHT selbst referenzieren, weder direkt noch transitiv. |
DP-18 | 4.8, 4.9, 4.14 | semantisch | Jede DataPoint-ID, die die expression einer ruml:query oder einer ruml:expression liest, und jede ID in inputs.dataPoints einer ruml:ai-query MUSS ein Schlüssel im data von ruml:datapoints sein. |
8.9 Regeln zu Textreferenzen
Regeln abgeleitet aus Kapitel 4.12.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
TXT-01 | 4.12 | Schema | Die Payload des ruml:text-reference-Eintrags eines Knotens MUSS refs mit mindestens einem Anker haben. Ein Anker MUSS id und type (represents oder refers-to) haben und DARF KEINE anderen Felder als diese und element (eine kleingeschriebene UUID) haben, das ein Parser akzeptieren MUSS; ein Knoten DARF NICHT mehr als einen represents-Anker haben, und derselbe Anker DARF NICHT zweimal vorkommen. |
TXT-02 | 4.12 | Schema | Ein Text-Schlüssel MUSS dem Muster [a-z_][a-z0-9_]* entsprechen. |
TXT-03 | 4.12 | — | Ein Text-Schlüssel DARF sich NICHT ändern, sobald Anker auf ihn zeigen können, und die GUID eines Elements DARF sich NICHT ändern; ein Werkzeug, das eine neue Version eines Textes importiert, MUSS die GUID jedes Elements, das es zuordnet, in die neue Version übernehmen. |
TXT-04 | 4.12 | Schema | Ein Text-Eintrag MUSS title und timestamp haben, und status, sofern er kein content hat. |
TXT-05 | 4.12 | semantisch | In einem Text-Eintrag MÜSSEN timestamp und validFrom Datum-Uhrzeit-Werte nach RFC 3339 sein, url eine URI und language ein ISO-639-1-Code. |
TXT-06 | 4.12 | Schema | Ein Parser MUSS einen Text-Eintrag mit jedem der optionalen Felder type, text, content, version, validFrom, validUntil, language und isReferenced akzeptieren. |
TXT-07 | 4.12 | Schema | Ein Text-Eintrag DARF NICHT zugleich text und content haben; ein eingebetteter Eintrag mit Status inForce MUSS ein nicht-leeres text oder ein content haben. |
TXT-08 | 4.12 | Schema | Ein Text-Eintrag mit content MUSS digest haben, sha3-256: gefolgt von 64 Hexadezimalziffern in Kleinbuchstaben. |
TXT-09 | 4.12 | semantisch | digest MUSS dem SHA3-256-Hash der UTF-8-Bytes der RFC-8785-Form von content entsprechen. |
TXT-10 | 4.12 | Schema | Ein Text-Eintrag mit type url, container oder external MUSS entsprechend url, containerPath oder ref haben. |
TXT-11 | 4.12 | Schema | Der containerPath eines Text-Eintrags MUSS mit .texts/ beginnen. |
TXT-12 | 4.12 | semantisch | Hat ein Text-Eintrag beide, MUSS validUntil später als validFrom sein. |
TXT-13 | 4.12 | semantisch | In einem Text-Eintrag mit content MÜSSEN status, validFrom, validUntil, language und version mit den Metadaten des Textes selbst übereinstimmen. |
TXT-14 | 4.12 | semantisch | In content DARF ein content-Array KEINE zwei benachbarten Strings enthalten. |
TXT-15 | 4.12 | Schema | Die Wurzel von content MUSS type, attrs und content haben und MUSS den Namensraum ihres Dialekts als Standard-Namensraum deklarieren (attrs.xmlns). |
TXT-16 | 4.12 | semantisch | In content MUSS jedes Element mit einer eId eine GUID haben, eine kleingeschriebene UUID, eindeutig innerhalb des Eintrags; ein Element außer der Wurzel DARF xmlns NICHT deklarieren; jedes Namensraum-Präfix MUSS durch ein Attribut xmlns:<prefix> am Element oder einem Vorfahren deklariert sein; und ein Element DARF KEIN xsi:schemaLocation haben. |
TXT-17 | 4.12 | — | Ein Werkzeug, das RUML Text schreibt, MUSS die Elemente und Attribute jedes Namensraums beibehalten, auch solche, die es nicht versteht, und DARF KEINE Satzmarker hinzufügen, die die Quelle nicht enthält. |
TXT-18 | 4.12 | semantisch | In XML umgewandelt MUSS content gegen die Schemas des Dialekts gültig sein, den sein Wurzel-Namensraum benennt; ein Fragment MUSS dort gültig sein, wo es in einem vollständigen Dokument steht. |
TXT-19 | 4.9, 4.12 | semantisch | Jede id eines Ankers in den refs des ruml:text-reference-Eintrags eines Knotens und jede ID in inputs.texts einer ruml:ai-query MUSS ein Schlüssel im data von ruml:text-reference sein. |
TXT-20 | 4.12 | semantisch | Das element eines Ankers MUSS die GUID eines Elements im content des Eintrags sein, den seine id benennt; ein Anker in einen Eintrag ohne content DARF KEIN element haben. |
8.10 Regeln zum Kontext
Regeln abgeleitet aus Kapitel 4.11.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
CTX-01 | 4.11 | Schema | Ein Context-Eintrag MUSS title, category und timestamp haben. |
CTX-02 | 4.11 | Schema | category MUSS eine der Kategorien aus 4.11.1 sein. |
CTX-03 | 4.11, 4.11.2 | Schema | In einem Context-Eintrag MUSS timestamp ein Datum-Uhrzeit-Wert nach RFC 3339 sein, accessDate ein Datum nach RFC 3339 und url eine URI. |
CTX-04 | 4.11 | Schema | Ein Context-Schlüssel MUSS dem Muster [a-z_][a-z0-9_]* entsprechen. |
CTX-05 | 4.11 | Schema | Dieselbe Context-ID DARF NICHT mehr als einmal in den refs des ruml:context-Eintrags eines Knotens vorkommen. |
CTX-06 | 4.11 | Schema | Ein Parser MUSS einen Context-Eintrag mit jedem der optionalen Felder type, subject, metadata, content, source, hash und accessDate akzeptieren, die letzten beiden bei jedem type. |
CTX-07 | 4.11, 4.11.2 | Schema | Ein Context-Eintrag mit type url, container oder external MUSS entsprechend url, containerPath oder ref haben. |
CTX-08 | 4.11 | Schema | hash MUSS aus sha3-256, sha256 oder blake3 bestehen, gefolgt von : und 64 Hexadezimalziffern in Kleinbuchstaben. |
CTX-09 | 4.11.2 | Schema | Der containerPath eines Context-Eintrags MUSS mit .context/ beginnen. |
CTX-10 | 4.9, 4.11 | semantisch | Jede ID in den refs des ruml:context-Eintrags eines Knotens und jede Context-ID in inputs.context einer ruml:ai-query MUSS ein Schlüssel im data von ruml:context sein. |
8.11 Regeln zu modularen Knoten
Regeln abgeleitet aus Kapitel 6.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
MOD-01 | 3.5.3, 6.2, 6.4 | semantisch | Ein Knoten, dessen LexID mehr als einmal in den children-Arrays der Rulemap vorkommt (eine Selbstreferenz zählt mit), MUSS modular: true haben. |
MOD-02 | 6.4 | semantisch | Ein Parser MUSS einen modularen Knoten akzeptieren, der seine eigene LexID in seinen children aufführt (Rekursion). |
MOD-03 | 6.4 | — | Eine Implementierung MUSS bei einem rekursiven Knoten mit dem Operator AND, NOT_AND, OR oder NOT_OR eine Warnung ausgeben; die Warnung allein macht die Datei nicht ungültig. |
MOD-04 | 6.4 | semantisch | Eine Selbstreferenz DARF NICHT der erste Eintrag von children sein. |
MOD-05 | 6.4 | semantisch | Ein rekursiver Knoten MUSS mindestens ein Kind haben, das keine Selbstreferenz ist. |
MOD-06 | 6.5 | semantisch | Ein Parser MUSS einen modularen Knoten unter den Kindern eines anderen modularen Knotens akzeptieren, auch wenn er an anderer Stelle referenziert wird. |
8.12 Regeln zu Baumreferenzen
Regeln abgeleitet aus Kapitel 4.15 und 4.16.
| Regel | § | Ebene | Anforderung |
|---|---|---|---|
TREE-01 | 4.15, 4.16 | Schema | Die Root-Level-Einträge von ruml:tree-reference und ruml:tree-include DÜRFEN KEINE Payload haben. Die ruml:tree-reference-Payload eines Knotens MUSS represents, refersTo (mit mindestens einem Eintrag) oder beide enthalten, und represents und jeder refersTo-Eintrag MÜSSEN genau uri haben; die ruml:tree-include-Payload eines Knotens MUSS uri enthalten. Beide Payloads DÜRFEN KEINE weiteren Felder enthalten. |
TREE-02 | 4.15, 4.16 | Schema | Jede uri einer Baumreferenz oder Einbindung MUSS ein Knotenanker <ruml-version-uri>#node/<id> sein; ein Anker innerhalb des Dokuments (#node/…) ist keiner. |
TREE-03 | 4.15 | Schema | Dieselbe uri DARF NICHT zweimal in refersTo vorkommen. |
TREE-04 | 4.15, 4.16 | semantisch | Der Zielknoten eines Knotenankers MUSS in der referenzierten Version existieren. |
TREE-05 | 4.15 | semantisch | Ein Parser MUSS ruml:tree-reference-Einträge akzeptieren, die Zyklen über Dateien hinweg bilden. |
TREE-06 | 4.15, 4.16 | semantisch | Ein Knotenanker MUSS eine unveränderliche RUML-Version benennen; eine Datei, die exportiert oder ausgetauscht wird, DARF KEINEN Anker ohne Version enthalten. Alle Knotenanker einer Datei in dieselbe andere RUML-Datei MÜSSEN dieselbe Version davon verwenden. |
TREE-07 | 4.15 | Schema | Ein Parser MUSS einen Knoten akzeptieren, der neben einem ruml:tree-reference-Eintrag ruml:text-reference-Anker hat. |
TREE-08 | 4.16 | Schema | Ein Knoten mit ruml:tree-include DARF in seiner ruml:tree-reference KEIN represents haben. |
TREE-09 | 4.16 | semantisch | Einbindungen DÜRFEN KEINEN Zyklus über Dateien hinweg bilden, weder direkt noch über weitere Dateien. |