docs: sync schemas and specs with source changes#5250
Conversation
Add missing Section 5 entry for apiProxy.maxCacheMisses, which maps to the --max-cache-misses <number> CLI flag and AWF_MAX_CACHE_MISSES env var. The field was present in docs/awf-config.schema.json, the config-file.ts interface, and src/cli-options.ts, but omitted from the spec's CLI mapping table. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the normative CLI mapping table in docs/awf-config-spec.md to include the previously missing config-to-CLI mapping for apiProxy.maxCacheMisses, keeping the documentation aligned with the implemented CLI flag and schema.
Changes:
- Added the missing mapping entry for
apiProxy.maxCacheMisses→--max-cache-misses <number>in the §5 CLI mapping table.
Show a summary per file
| File | Description |
|---|---|
| docs/awf-config-spec.md | Adds the missing apiProxy.maxCacheMisses → --max-cache-misses <number> line to the normative CLI mapping table. |
Copilot's findings
Tip
Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
- Files reviewed: 1/1 changed files
- Comments generated: 0
|
✅ Contribution Check completed successfully! |
|
📡 Smoke OTel Tracing completed. All tracing scenarios validated. ✅ |
|
✅ Smoke Copilot BYOK AOAI (api-key) completed. Copilot AOAI BYOK (api-key) mode operational. 🔓 |
|
🔌 Smoke Services — All services reachable! ✅ |
|
✅ Smoke Copilot BYOK completed. Copilot BYOK mode operational. 🔓 |
|
✨ The prophecy is fulfilled... Smoke Codex has completed its mystical journey. The stars align. 🌟 |
|
Chroot tests passed! Smoke Chroot - All security and functionality tests succeeded. |
|
✅ Smoke Gemini completed. All facets verified. 💎 Smoke test complete. Results: MCP ✅, File ✅, Bash ✅, Connectivity ❌. Summary posted to PR #5250. |
|
✅ Build Test Suite completed successfully! |
|
❌ Smoke Claude failed |
|
✅ Smoke Copilot BYOK AOAI (Entra) completed. Copilot AOAI BYOK (Entra) mode operational. 🔓 |
|
🔑 Smoke Copilot PAT PAT auth validated. All systems operational. ✅ |
|
📰 VERDICT: Smoke Copilot has concluded. All systems operational. This is a developing story. 🎤 |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
|
🚀 Security Guard has started processing this pull request |
|
✅ Smoke Gemini completed. All facets verified. 💎 Smoke test completed. Overall status: FAIL due to connectivity issues. |
|
❌ Smoke Claude failed |
|
✅ Build Test Suite completed successfully! |
|
📰 VERDICT: Smoke Copilot has concluded. All systems operational. This is a developing story. 🎤 |
|
❌ Smoke Copilot BYOK AOAI (Entra) reports failed. AOAI BYOK (Entra) mode investigation needed... |
|
📡 Smoke OTel Tracing completed. All tracing scenarios validated. ✅ |
|
✅ Smoke Copilot BYOK AOAI (api-key) completed. Copilot AOAI BYOK (api-key) mode operational. 🔓 |
|
✨ The prophecy is fulfilled... Smoke Codex has completed its mystical journey. The stars align. 🌟 |
|
✅ Smoke Copilot BYOK completed. Copilot BYOK mode operational. 🔓 |
|
🔑 Smoke Copilot PAT PAT auth validated. All systems operational. ✅ |
BYOK Smoke Test Results ✅Test Summary:
Mode: Direct BYOK (COPILOT_PROVIDER_API_KEY via api-proxy sidecar) /cc
|
🤖 Smoke Test Results — PASS
Overall: PASS · PR: docs: sync schemas and specs with source changes ·
|
🔬 Smoke Test: Copilot PAT Auth — PASS
Overall: PASS · Auth mode: PAT (COPILOT_GITHUB_TOKEN) PR: docs: sync schemas and specs with source changes · Author:
|
📡 Smoke Test: API Proxy OpenTelemetry Tracing
Overall: ✅ No unexpected failures. Scenarios 3 & 5 are pending implementation of env var forwarding to the api-proxy container.
|
|
Smoke test results:
Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "registry.npmjs.org"See Network Configuration for more information.
|
Chroot Runtime Version Comparison
Result: ❌ Not all versions match — Python and Node.js differ between host and chroot environments.
|
|
Smoke test results:
Running in direct BYOK mode (AWF_AUTH_TYPE=github-oidc + AWF_AUTH_AZURE_* + COPILOT_PROVIDER_BASE_URL) via api-proxy → Azure OpenAI (Foundry, o4-mini-aw) authenticated via Microsoft Entra Overall: PASS
|
Smoke Test: Gemini Engine Validation
Overall status: FAIL Warning Firewall blocked 1 domainThe following domain was blocked by the firewall during workflow execution:
network:
allowed:
- defaults
- "localhost"See Network Configuration for more information.
|
🏗️ Build Test Suite Results
Overall: 8/8 ecosystems passed — ✅ PASS
|
|
Smoke Test Results
Running in direct BYOK mode (COPILOT_PROVIDER_API_KEY + COPILOT_PROVIDER_BASE_URL) via api-proxy → Azure OpenAI (Foundry, o4-mini-aw) Overall: PASS
|
Smoke Test Results
Overall: FAIL
|
Summary
Adds the missing
apiProxy.maxCacheMissesCLI mapping entry to Section 5 ofdocs/awf-config-spec.md.What changed
docs/awf-config-spec.md— Added the missing mapping line:The field was already present in:
docs/awf-config.schema.json(propertymaxCacheMisses, minimum: 1)src/config-file.ts(AwfFileConfig.apiProxy.maxCacheMisses, mapped inmapAwfFileConfigToCliOptions)src/cli-options.ts(--max-cache-misses <number>, line 357)src/services/api-proxy-service-config.ts(setsAWF_MAX_CACHE_MISSES)...but was absent from the spec's normative CLI mapping table in §5.
Triggering commit
57a7d49— Add comprehensive gVisor firewall comparison workflow (#5236) — touchedsrc/config-file.tsamong other source files.No other schema changes needed
schemas/audit.schema.json— matchessrc/squid/config-generator.tsaudit_jsonllog format exactly (all 10 fields present).schemas/token-usage.schema.json— matchescontainers/api-proxy/token-persistence.jsbuildTokenUsageRecordand optionalx_initiator/billingdecorators fromtoken-tracker-http.jsexactly.docs/awf-config.schema.json— no new config fields detected.schemas/README.md— no structural/versioning changes detected.