vultr/openclaw
1
0
Fork 0
mirror of https://github.com/openclaw/openclaw.git synced 2026-05-06 03:50:33 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: refresh config schema mirror refs

Browse Source
This commit is contained in:
Peter Steinberger
2026-04-04 20:45:46 +01:00
parent e336300e60
commit 4b993ba6e4
4 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/cli/config.md
View File

@@ -54,7 +54,7 @@ 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
- Nested object, wildcard (`*`), and array-item (`[]`) nodes inherit the same `title` / `description` metadata 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

4
docs/cli/index.md
View File

@@ -579,7 +579,7 @@ Subcommands:
- `config set --strict-json`: require JSON5 parsing for path/value input. `--json` remains a legacy alias for strict parsing outside dry-run output mode.
- `config unset <path>`: remove a value.
- `config file`: print the active config file path.
- `config schema`: print the generated JSON schema for `openclaw.json`, including field docs and best-effort live plugin/channel schema metadata.
- `config schema`: print the generated JSON schema for `openclaw.json`, including field `title` / `description` metadata and best-effort live plugin/channel schema metadata.
- `config validate`: validate the current config against the schema without starting the gateway.
- `config validate --json`: emit machine-readable JSON output.
@@ -1462,7 +1462,7 @@ Notes:
Common RPCs:
- `config.schema.lookup` (inspect one config subtree with shallow schema fields, docs, and immediate child summaries)
- `config.schema.lookup` (inspect one config subtree with a shallow schema node, matched hint metadata, 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)

3
docs/gateway/configuration.md
View File

@@ -532,7 +532,8 @@ Control-plane write RPCs (`config.apply`, `config.patch`, `update.run`) are rate
Safe/default flow:
- `config.schema.lookup`: inspect one path-scoped config subtree with field docs
- `config.schema.lookup`: inspect one path-scoped config subtree with a shallow
schema node, matched hint metadata, and immediate child summaries
- `config.get`: fetch the current snapshot + hash
- `config.patch`: preferred partial update path
- `config.apply`: full-config replacement only

2
docs/help/faq.md
View File

@@ -1775,7 +1775,7 @@ for usage/billing and raise limits as needed.
<Accordion title="Is there an API / RPC way to apply config?">
Yes.
- `config.schema.lookup`: inspect one config subtree with its shallow schema fields, matched UI hint, and immediate child summaries before writing
- `config.schema.lookup`: inspect one config subtree with its shallow schema node, matched UI hint, and immediate child summaries before writing
- `config.get`: fetch the current snapshot + hash
- `config.patch`: safe partial update (preferred for most RPC edits)
- `config.apply`: validate + replace the full config, then restart