docs: refresh config schema output refs

This commit is contained in:
Peter Steinberger
2026-04-04 20:35:01 +01:00
parent 976bc47458
commit ba8eb4af38
4 changed files with 29 additions and 5 deletions

View File

@@ -54,9 +54,17 @@ What it includes:
- The current root config schema, plus a root `$schema` string field for editor tooling
- Field `title` and `description` metadata derived from the same labels/help used by the Control UI
- Nested object, wildcard (`*`), and array-item (`[]`) nodes inherit the same field docs when labels/help exist
- Best-effort live plugin + channel schema metadata when runtime manifests can be loaded
- A clean fallback schema even when the current config is invalid
Related runtime RPC:
- `config.schema.lookup` returns one normalized config path with a shallow
schema node (`title`, `description`, `type`, `enum`, `const`, common bounds),
matched UI hint metadata, and immediate child summaries. Use it for
path-scoped drill-down in Control UI or custom clients.
```bash
openclaw config schema
```

View File

@@ -1460,7 +1460,7 @@ Notes:
Common RPCs:
- `config.schema.lookup` (inspect one config subtree with field docs)
- `config.schema.lookup` (inspect one config subtree with shallow schema fields, docs, and immediate child summaries)
- `config.get` (read current config snapshot + hash)
- `config.set` (validate + write full config; use `baseHash` for optimistic concurrency)
- `config.apply` (validate + write config + restart + wake)