configuration::get
functionRead a configuration by id. Expands ${VAR:default} placeholders against the live process env unless raw=true is passed.
rawboolean
When `true`, return the stored value verbatim (including `${VAR}` placeholders). When `false` (default), expand `${VAR:default}` against the live process env.
configuration::list
functionList every registered configuration with id, name, description, and schema. Sorted by id; never returns the stored value.
configurationsobject[]*required
descriptionstring*required
configuration::register
functionRegister a configuration id with a name, description, and JSON Schema. Idempotent — re-registering replaces metadata and (when initial_value is provided) the value. Validates initial_value against the schema.
descriptionstring*required
Description shown in `configuration::list`.
idstring*required
Configuration id. Must match `[a-z0-9_-]{1,64}` so it is safe as a filename in the `fs` adapter.
initial_valueunknown
Optional initial value to install. Validated against `schema`.
metadataunknown
Optional opaque metadata stored alongside the entry.
namestring*required
Human-readable name shown in `configuration::list`.
schemaunknown*required
JSON Schema describing the value shape. `set` validates against this.
descriptionstring*required
One-line description of what this configuration controls.
idstring*required
Stable identifier (e.g. `iii-stream`, `iii-observability`).
metadataunknown
Optional caller-supplied metadata (owner team, change ticket, etc.).
namestring*required
Human-readable display name.
schemaunknown*required
JSON Schema describing the shape of `value`.
valueunknown
Stored configuration body. May contain `${VAR:default}` placeholders.
configuration::schema
functionRetrieve the schema, name, and description for a configuration id. Mirrors a single entry from configuration::list.
descriptionstring*required
configuration::set
functionReplace the value of an already-registered configuration. Validates the value against the registered JSON Schema and emits a configuration:updated event.
valueunknown*required
New configuration value. Validated against the registered schema.
new_valueunknown*required
Current stored value (templates not expanded).
old_valueunknown
Previous stored value, or `null` when the entry had no value yet.