From 85bf10a0678bba2666e106ec0fa16eae84fb0611 Mon Sep 17 00:00:00 2001 From: Taylor Mutch Date: Tue, 16 Jun 2026 09:17:26 -0700 Subject: [PATCH] docs(gateway): clarify runtime settings registry Signed-off-by: Taylor Mutch --- crates/openshell-server/src/runtime_config.rs | 2 ++ docs/reference/gateway-config.mdx | 2 +- 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/crates/openshell-server/src/runtime_config.rs b/crates/openshell-server/src/runtime_config.rs index cc28cb0ad..6e33b7f8a 100644 --- a/crates/openshell-server/src/runtime_config.rs +++ b/crates/openshell-server/src/runtime_config.rs @@ -118,6 +118,8 @@ struct RawOpenShellRuntimeRoot { #[derive(Debug, Default, Deserialize)] #[serde(deny_unknown_fields)] struct RawRuntimeSection { + // Keep this as a key/value map so runtime config files use the same + // openshell_core::settings registry as CLI and gRPC settings writes. #[serde(default)] settings: BTreeMap, } diff --git a/docs/reference/gateway-config.mdx b/docs/reference/gateway-config.mdx index cf4eb4ba5..4cb1c182f 100644 --- a/docs/reference/gateway-config.mdx +++ b/docs/reference/gateway-config.mdx @@ -161,7 +161,7 @@ ocsf_json_enabled = true proposal_approval_mode = "manual" ``` -Only registered runtime setting keys are accepted. The gateway rejects unknown keys, the reserved `policy` key, values with the wrong TOML type, and invalid enum strings. +Only registered runtime setting keys are accepted. The runtime file accepts the same key names and value types as the global settings API. The gateway rejects unknown keys, the reserved `policy` key, values with the wrong TOML type, and invalid enum strings. When a runtime settings file is configured, keys present in that file are file-managed. `openshell settings set --global` and `openshell settings delete --global` reject changes to those keys; update the file instead. Keys omitted from the file remain managed through the normal global settings API. Removing a key from the file stops file-managing that key but does not delete the last persisted global value.