Skip to content

Common definitions 0.1

Schema reference / Common definitions / 0.1

Shared IDs, versions, paths, poses, revisions, capabilities, areas and mounts referenced by the world and IPC schemas.

Status
Frozen · latest is 0.11
Published
2026-10-07
Title
“Hyprune v0 common”
Dialect
JSON Schema 2020-12 · unknown fields rejected unless marked
Raw schemacommon.schema.json · 85 lines · 1.9 KB
DownloadOpen rawsha256 051da0368f3f…
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "https://hyprune.com/schema/v0/common.schema.json",
"title": "Hyprune v0 common",
"$defs": {
"id": {
"type": "string",
"minLength": 1,
"maxLength": 128,
"pattern": "^[a-z][a-z0-9-]*(\\.[a-z][a-z0-9-]*)+$"
},
"slug": {
"type": "string",
"minLength": 1,
"maxLength": 64,
"pattern": "^[a-z][a-z0-9-]*$"
},
"version": {
"type": "string",
"minLength": 1,
"maxLength": 256,
"pattern": "^(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)\\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?(\\+[0-9A-Za-z-]+(\\.[0-9A-Za-z-]+)*)?$"
},
"path": {
"type": "string",
"minLength": 1,
"maxLength": 512,
"pattern": "^(?!.*(?:^|/)\\.{1,2}(?:/|$))[A-Za-z0-9_.-]+(?:/[A-Za-z0-9_.-]+)*$"
},
"pose": {
"type": "object",
"properties": {
"position": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 3,
"maxItems": 3
},
"rotation": {
"type": "array",
"items": {
"type": "number"
},
"minItems": 4,
"maxItems": 4
}
},
"required": [
"position",
"rotation"
],
"additionalProperties": false
},
"index": {
"type": "integer",
"minimum": 0
},
"capability": {
"enum": [
"state.read",
"world.control",
"surface.control",
"movement.control",
"shell.control",
"runtime.control"
]
},
"extensions": {
"type": "object",
"propertyNames": {
"$ref": "common.schema.json#/$defs/id"
},
"additionalProperties": {
"type": "object"
}
},
"revision": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991
}
}
}

This is the first published version of this contract.

Definitions

id#

string · length 1–128 · pattern ^[a-z][a-z0-9-]*(\.[a-z][a-z0-9-]*)+$

slug#

string · length 1–64 · pattern ^[a-z][a-z0-9-]*$

version#

string · length 1–256 · pattern ^(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)\.(0|[1-9][0-9]*)(-[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?(\+[0-9A-Za-z-]+(\.[0-9A-Za-z-]+)*)?$

path#

string · length 1–512 · pattern ^(?!.*(?:^|/)\.{1,2}(?:/|$))[A-Za-z0-9_.-]+(?:/[A-Za-z0-9_.-]+)*$

pose#

object

FieldTypeConstraints
positionrequirednumber[3]
rotationrequirednumber[4]

index#

integer · ≥ 0

capability#

"state.read" | "world.control" | "surface.control" | "movement.control" | "shell.control" | "runtime.control"

extensions#

map → object · keys: id

revision#

integer · ≥ 0 · ≤ 2⁵³−1

Mirrored byte-for-byte from hyprune/schema at 34849da45183 (2026-10-15). SHA-256 051da0368f3fb8242632b616d9583b34798df2d3f401840a4a26c86396796506.