Skip to content
RUMLRUML

Open Format for Digital Law

2.2 File Structure Overview

The root object: discriminators, required fields, node keys.

minimal-file-is-valid

DescriptionThe minimal valid file the spec prints in §2.2.
Expectaccept
Layerschema
RUML2-2-file-structure.fixtures/accept-minimal-file-is-valid.ruml
Spec§2.2
2-2-file-structure.fixtures/accept-minimal-file-is-valid.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"label": "Root"
}
}
}
}

wrong-format-discriminator

Description`$format` is `"RMLX"` instead of the required `"RUML"`.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-wrong-format-discriminator.ruml
Spec§2.2
Expected rule violationsFMT-03
At/$format
2-2-file-structure.fixtures/reject-wrong-format-discriminator.ruml
{
"$format": "RMLX",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"operator": "AND",
"label": "root",
"children": ["2", "3"]
},
"2": {
"id": "6840b48d-117f-474e-ae4e-337b8e60537c",
"label": "One"
},
"3": {
"id": "95f566ad-b37c-4a18-b004-e83274d0fe83",
"label": "Two"
}
}
}
}

unsupported-spec-version

Description`$specVersion` is `"0.2"`, which is not a supported version.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-unsupported-spec-version.ruml
Spec§2.2
Expected rule violationsFMT-04
At/$specVersion
2-2-file-structure.fixtures/reject-unsupported-spec-version.ruml
{
"$format": "RUML",
"$specVersion": "0.2",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"operator": "AND",
"label": "root",
"children": [
"2",
"3"
]
},
"2": {
"id": "6840b48d-117f-474e-ae4e-337b8e60537c",
"label": "One"
},
"3": {
"id": "95f566ad-b37c-4a18-b004-e83274d0fe83",
"label": "Two"
}
}
}
}

missing-metadata

DescriptionThe root `metadata` object is missing entirely.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-missing-metadata.ruml
Spec§2.2
Expected rule violationsFMT-06
At
2-2-file-structure.fixtures/reject-missing-metadata.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"operator": "AND",
"label": "root",
"children": ["2", "3"]
},
"2": {
"id": "6840b48d-117f-474e-ae4e-337b8e60537c",
"label": "One"
},
"3": {
"id": "95f566ad-b37c-4a18-b004-e83274d0fe83",
"label": "Two"
}
}
}
}

missing-rulemap

DescriptionThe root `rulemap` object is missing entirely.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-missing-rulemap.ruml
Spec§2.2
Expected rule violationsFMT-06
At
2-2-file-structure.fixtures/reject-missing-rulemap.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
}
}

unknown-root-field

DescriptionAn unknown root field `rulemapp` (a typo of `rulemap`) is present.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-unknown-root-field.ruml
Spec§2.2
Expected rule violationsFMT-07
At/rulemapp
2-2-file-structure.fixtures/reject-unknown-root-field.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"id": "0eb360a6-626a-406d-89a1-9f434ced141b",
"operator": "AND",
"label": "root",
"children": ["2", "3"]
},
"2": {
"id": "6840b48d-117f-474e-ae4e-337b8e60537c",
"label": "One"
},
"3": {
"id": "95f566ad-b37c-4a18-b004-e83274d0fe83",
"label": "Two"
}
}
},
"rulemapp": {}
}

no-root-node

Description`rulemap.nodes` has no entry with key `"1"`, so there is no root node.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-no-root-node.ruml
Spec§2.2§2.6
Expected rule violationsFMT-08
At/rulemap/nodes
2-2-file-structure.fixtures/reject-no-root-node.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "ec36948d-fbb2-4815-985a-bd5e9375d934",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"2": {
"id": "6840b48d-117f-474e-ae4e-337b8e60537c",
"label": "orphan"
}
}
}
}

node-without-uuid

DescriptionThe root node has no `id`, but every node MUST have one.
Expectreject
Layerschema
RUML2-2-file-structure.fixtures/reject-node-without-uuid.ruml
Spec§2.2§3.5.2
Expected rule violationsNODE-01
At/rulemap/nodes/1
2-2-file-structure.fixtures/reject-node-without-uuid.ruml
{
"$format": "RUML",
"$specVersion": "1.0",
"metadata": {
"id": "3c9a1e2f-7b4d-4f6a-8c1d-5e2f3a4b6c7d",
"version": "1.0.0",
"created": "2024-01-01T00:00:00Z",
"modified": "2024-01-01T00:00:00Z",
"status": "draft"
},
"rulemap": {
"nodes": {
"1": {
"label": "Root"
}
}
}
}