Skip to content

changeset.rk ​

A proposed change to metadata: the only way Rangka AI (and the Console) changes a running installation. Validated, previewed on a copy, approved by a person, applied as a reversible migration, recorded in the audit log.

Lives in sent to /api/v1/changesets (not a file on disk) · Schema changeset.json (source) · first line: # yaml-language-server: $schema=https://rangka-os.github.io/rangka-os/schema/0.5/changeset.json

Properties ​

PropertyTypeMeaning
id requiredstring
pattern ^cs_[a-z0-9]{6,}$
title requiredstring
reasonstring
author requiredobject
author.kind requireduser · ai · console · cli
author.id requiredstring
author.modelstringLLM used, when kind is ai
orgstringOrganisation the change applies to; omitted for installation-wide (app) changes
ops requiredlist of object
at least 1
ops[].op requiredcreate · replace · patch · delete
ops[].path requiredstring
pattern ^(apps/[a-z0-9_]+/(app|models/[a-z0-9_]+|dashboards/[a-z0-9_]+|screens/[a-z0-9_]+|flows/[a-z0-9_]+|roles/[a-z0-9_]+)|modules/[a-z0-9_]+/(module|models/[a-z0-9_]+|dashboards/[a-z0-9_]+|screens/[a-z0-9_]+|flows/[a-z0-9_]+|roles/[a-z0-9_]+)|custom/[a-z0-9_]+|custom/app\.[a-z][a-z0-9_]*|models/[a-z0-9_]+|flows/[a-z0-9_]+|system|themes/[a-z0-9_]+|layouts/[a-z0-9_]+|processes/[a-z][a-z0-9_]*|dashboards/[a-z0-9_]+|features|config|connectors/[a-z0-9_]+)\.rk$
ops[].contentstringFull .rk text for create/replace
ops[].basestringSHA-256 (hex) of the file text the op was computed from; when the file has changed since, validate, preview and apply answer stale_base
pattern ^[0-9a-f]{64}$
ops[].patchlist of objectRFC 6902 JSON Patch against the parsed file, for patch
ops[].patch[].op requiredadd · remove · replace · move · copy · test
ops[].patch[].path requiredstring
ops[].patch[].value
ops[].patch[].fromstring
layerslist of 2 · 3 · 4 · 5 · 6Computed: layers touched
risklow · medium · highComputed: high when it touches system.rk, roles/permissions, money or stock fields, drops data, or changes submitted-document models
sourceai · catalogueSet by the kernel: ai when the AI assistant (an assistant token, contract 0020) proposed the change set, catalogue when POST /api/v1/catalogue/propose built it (contract 0036); absent otherwise
status requireddraft · proposed · validated · invalid · previewed · approved · rejected · applied · reverted · failed
validationobject
validation.errorslist of items
validation.warningslist of items
previewobjectDry-run result: migrations (SQL), affected records count, screens changed
preview.migrationslist of string
preview.affectedmap of integer
preview.reversibleboolean
preview.fileslist of object
preview.files[].path requiredstring
preview.files[].beforestring or null
preview.files[].afterstring or null
historylist of object
history[].status requiredstring
history[].at requiredstring
date-time
history[].by requiredstring
history[].notestring
created_atstring
date-time
updated_atstring
date-time

Generated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.

Rangka OS is source-available under the Elastic License 2.0 (ELv2). Free to self-host.