49 lines
5.1 KiB
Markdown
49 lines
5.1 KiB
Markdown
|
# Portable configuration: meguri/v1
|
||
|
|
|
||
|
|
The Import / Export action in Review changes transfers only variables and generators from the shared draft. It excludes credentials, provider settings, manual resources, memberships and calendar history. Export is JSON; the textarea supports copying and downloading. Import parses and previews on the server after typing stops, without saving. Applying saves the reviewed shared draft, with both workspace and shared-draft revision checks. Saving checked changes and explicit provider synchronization retain their existing meanings.
|
||
|
|
|
||
|
|
## Merge and identity
|
||
|
|
|
||
|
|
The top-level object requires `format: "meguri/v1"`, `variables`, and `generators`. Unknown fields are errors. Arrays preserve order. Match variable and generator names case-insensitively after trimming, update matching inputs in place, append new inputs, and retain omitted inputs. Names must be unique. Renaming creates a new input; removing inputs remains an explicit UI action. Existing generator order and routing insertion position remain unchanged; new generators append in document order. A generator entry replaces that generator's complete iterations, condition and blocks, so the preview can include removed generated resources.
|
||
|
|
|
||
|
|
Nested variable nodes and output blocks have optional `id` strings. Export includes them. These are portable identity keys, not workspace access identifiers. Keep them when changing values or reordering entries. Import into another workspace remaps them deterministically within the owning variable/generator; repeat import preserves generated identity. For hand-written documents, use descriptive block IDs (for example `daytime`). If omitted, IDs fall back to existing positions or deterministic positions; moving ID-less list entries does not preserve logical item identity. Iterations are referenced by their names within a generator. Generated output bindings identify `[generator-name, block-id]`.
|
||
|
|
|
||
|
|
## Types and bindings
|
||
|
|
|
||
|
|
A variable has `name` and `node`. Nodes use `kind`, optional scalar `value`, and optional `entries`. Kinds are `text`, `person`, `number`, `boolean`, `date`, `time`, `duration`, `list`, and `dictionary`. Dictionary entries also have a `key`. Dates are ISO dates; times are local scheduling times; duration units follow the generator field contract. Every `person` node and literal person binding uses an email address. Existing unique workspace contacts resolve exactly by email. A new email becomes an email-only scheduling contact during generation, never a login or workspace member. A person with no stored scheduling email blocks export until it is supplied.
|
||
|
|
|
||
|
|
A generator has `name`, `enabled` (default true), `iterations`, optional `when`, and `blocks`. Blocks use `id`, `kind`, `fields`, and optionally `steps` and `conditions`, matching the visual editor. Binding objects use `kind` (`literal`, `variable`, `item`, `key`, `lookup`, `list`, `output`) with the appropriate `value`, `variable` name, `iteration` name, `output` pair, nested lookup `key`, or binding `items`. `path` is an array of dictionary keys or one-based list indexes written as strings; `prefix` and `suffix` modify text. A person used inside a generic literal (for example a predicate comparison) uses `{"$person":"alice@example.com"}` to preserve its type without a workspace UUID. No expressions or executable scripts are evaluated.
|
||
|
|
|
||
|
|
Literal fallback schedules and escalation references use exact names in the target workspace. They must resolve uniquely; import never creates manual resources. All generation, permission, coverage and provider-capability validation runs before Apply becomes available. External resource links should normally use output bindings for portability.
|
||
|
|
|
||
|
|
```json
|
||
|
|
{
|
||
|
|
"format": "meguri/v1",
|
||
|
|
"variables": [
|
||
|
|
{"name": "owners", "node": {"kind": "list", "entries": [
|
||
|
|
{"id": "alice", "kind": "person", "value": "alice@example.com"},
|
||
|
|
{"id": "bob", "kind": "person", "value": "bob@example.com"}
|
||
|
|
]}}
|
||
|
|
],
|
||
|
|
"generators": [
|
||
|
|
{
|
||
|
|
"name": "Weekly coverage",
|
||
|
|
"blocks": [{
|
||
|
|
"id": "weekly",
|
||
|
|
"kind": "rotation",
|
||
|
|
"fields": {
|
||
|
|
"name": {"kind": "literal", "value": "Platform on-call"},
|
||
|
|
"participants": {"kind": "variable", "variable": "owners"},
|
||
|
|
"anchor": {"kind": "literal", "value": "2026-09-28"},
|
||
|
|
"handover": {"kind": "literal", "value": "11:00"},
|
||
|
|
"shift_days": {"kind": "literal", "value": 7}
|
||
|
|
}
|
||
|
|
}]
|
||
|
|
}
|
||
|
|
]
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
Export an existing visual rule for examples of conditions, escalation steps, repeats, nested lookups and route filters. Import is limited to 1 MB of text and the existing bounded generation limits. Parse errors retain the input and disable application. The preview lists creates, updates and unchanged inputs separately from generated resource changes; it also lists new email-only contacts and displays validation errors and pending-request cancellations.
|
||
|
|
|
||
|
|
Escalation steps accept `team_random: true` to notify one random member of the workspace provider team, or `team_all: true` for everyone. Both default to false and are mutually exclusive with each other and `user: true`. Team modes ignore the recipient binding; export writes a null literal for it.
|