Skip to content

Commit 1ada124

Browse files
committed
docs(gateway): link runtime setting keys
Signed-off-by: Taylor Mutch <taylormutch@gmail.com>
1 parent ecf96ef commit 1ada124

1 file changed

Lines changed: 10 additions & 1 deletion

File tree

docs/reference/gateway-config.mdx

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,16 @@ ocsf_json_enabled = true
161161
proposal_approval_mode = "manual"
162162
```
163163

164-
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.
164+
Only [supported runtime setting keys](#supported-runtime-settings) 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.
165+
166+
### Supported Runtime Settings
167+
168+
| Key | Type | Values | Controls |
169+
|---|---|---|---|
170+
| `providers_v2_enabled` | Boolean | `true`, `false` | [Provider profile policy composition](/sandboxes/providers-v2) |
171+
| `ocsf_json_enabled` | Boolean | `true`, `false` | [OCSF JSON log export](/observability/ocsf-json-export) |
172+
| `agent_policy_proposals_enabled` | Boolean | `true`, `false` | [Policy advisor proposal surface](/sandboxes/policy-advisor) |
173+
| `proposal_approval_mode` | String | `manual`, `auto` | [Policy advisor approval mode](/sandboxes/policy-advisor#approval-modes) |
165174

166175
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.
167176

0 commit comments

Comments
 (0)