Skip to content

Commit bf10d9d

Browse files
lpcoxCopilotCopilot
authored
docs: add missing apiProxy CLI mappings and sync schema descriptions (#2759)
* docs: add missing apiProxy CLI mappings and sync schema descriptions Add three apiProxy entries missing from the §5 CLI mapping table in awf-config-spec.md: - apiProxy.anthropicAutoCache → --anthropic-auto-cache - apiProxy.anthropicCacheTailTtl → --anthropic-cache-tail-ttl - apiProxy.models → config-only (model alias rewriting) Sync src/awf-config-schema.json descriptions for apiProxy.enabled and environment to match docs/awf-config.schema.json, which already references §8–9 credential isolation and merge semantics. Supersedes #2753. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> --------- Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
1 parent 9e6c96f commit bf10d9d

2 files changed

Lines changed: 5 additions & 2 deletions

File tree

docs/awf-config-spec.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,8 +96,11 @@ the corresponding CLI flag.
9696
- `network.upstreamProxy``--upstream-proxy`
9797
- `apiProxy.enabled``--enable-api-proxy`
9898
- `apiProxy.enableOpenCode``--enable-opencode`
99+
- `apiProxy.anthropicAutoCache``--anthropic-auto-cache`
100+
- `apiProxy.anthropicCacheTailTtl``--anthropic-cache-tail-ttl <5m|1h>`
99101
- `apiProxy.maxEffectiveTokens`*(config-only; no CLI equivalent)*
100102
- `apiProxy.modelMultipliers`*(config-only; no CLI equivalent)*
103+
- `apiProxy.models`*(config-only; model alias rewriting)*
101104
- `apiProxy.targets.<provider>.host``--<provider>-api-target`
102105
- `apiProxy.targets.openai.basePath``--openai-api-base-path`
103106
- `apiProxy.targets.anthropic.basePath``--anthropic-api-base-path`

src/awf-config-schema.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@
4949
"properties": {
5050
"enabled": {
5151
"type": "boolean",
52-
"description": "Enable the API proxy sidecar container."
52+
"description": "Enable the API proxy sidecar container. When enabled, source credentials (OPENAI_API_KEY, ANTHROPIC_API_KEY, COPILOT_GITHUB_TOKEN, COPILOT_API_KEY, GEMINI_API_KEY) are held exclusively in the sidecar and excluded from the agent environment. The agent receives proxy-routing base URLs instead. See docs/awf-config-spec.md §9 for credential isolation semantics."
5353
},
5454
"enableOpenCode": {
5555
"type": "boolean",
@@ -235,7 +235,7 @@
235235
},
236236
"environment": {
237237
"type": "object",
238-
"description": "Environment variable propagation into the agent container.",
238+
"description": "Environment variable propagation into the agent container. Variables are merged in precedence order: AWF-reserved (lowest) → envFile → envAll → CLI -e/--env (highest). When apiProxy.enabled is true, source credentials (OPENAI_API_KEY, ANTHROPIC_API_KEY, etc.) are excluded from the agent and held in the API proxy sidecar. See docs/awf-config-spec.md §8–9 for normative merge and credential isolation rules.",
239239
"additionalProperties": false,
240240
"properties": {
241241
"envFile": {

0 commit comments

Comments
 (0)