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
| Property | Type | Meaning |
|---|---|---|
id required | string | pattern ^cs_[a-z0-9]{6,}$ |
title required | string | |
reason | string | |
author required | object | |
author.kind required | user · ai · console · cli | |
author.id required | string | |
author.model | string | LLM used, when kind is ai |
org | string | Organisation the change applies to; omitted for installation-wide (app) changes |
ops required | list of object | at least 1 |
ops[].op required | create · replace · patch · delete | |
ops[].path required | string | 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[].content | string | Full .rk text for create/replace |
ops[].base | string | SHA-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[].patch | list of object | RFC 6902 JSON Patch against the parsed file, for patch |
ops[].patch[].op required | add · remove · replace · move · copy · test | |
ops[].patch[].path required | string | |
ops[].patch[].value | ||
ops[].patch[].from | string | |
layers | list of 2 · 3 · 4 · 5 · 6 | Computed: layers touched |
risk | low · medium · high | Computed: high when it touches system.rk, roles/permissions, money or stock fields, drops data, or changes submitted-document models |
source | ai · catalogue | Set 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 required | draft · proposed · validated · invalid · previewed · approved · rejected · applied · reverted · failed | |
validation | object | |
validation.errors | list of items | |
validation.warnings | list of items | |
preview | object | Dry-run result: migrations (SQL), affected records count, screens changed |
preview.migrations | list of string | |
preview.affected | map of integer | |
preview.reversible | boolean | |
preview.files | list of object | |
preview.files[].path required | string | |
preview.files[].before | string or null | |
preview.files[].after | string or null | |
history | list of object | |
history[].status required | string | |
history[].at required | string | date-time |
history[].by required | string | |
history[].note | string | |
created_at | string | date-time |
updated_at | string | date-time |
Generated from the schema by website/scripts/gen-reference.mjs. Edit the schema, not this page.