docs: sync schemas and specs with source changes#2773
Conversation
Update apiProxy.maxEffectiveTokens description to use 'exceeded' instead of 'reached', aligning with the implementation change in commit 433d9aa which renamed event types from effective_tokens_limit_reached to effective_tokens_limit_exceeded. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
Updates the AWF configuration JSON schema documentation to reflect the recent effective-tokens limit wording change in the API proxy (“reached” → “exceeded”), keeping docs aligned with runtime behavior and log-detection patterns.
Changes:
- Updated
apiProxy.maxEffectiveTokensdescription in the published docs schema to say requests are rejected “when exceeded” rather than “when reached”.
Show a summary per file
| File | Description |
|---|---|
| docs/awf-config.schema.json | Adjusts apiProxy.maxEffectiveTokens description text to match the “exceeded” wording used by the API proxy/log patterns. |
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: 1
| "type": "integer", | ||
| "minimum": 1, | ||
| "description": "Maximum cumulative effective tokens allowed for a run. When reached, the API proxy rejects additional requests." | ||
| "description": "Maximum cumulative effective tokens allowed for a run. When exceeded, the API proxy rejects additional requests." |
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.
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.
|
@copilot merge main |
Also updated |
|
Smoke Test: Copilot BYOK — PASS
Running in BYOK offline mode (
|
Smoke Test Results✅ GitHub MCP: Last 2 merged PRs retrieved (#2774, #2773) Overall: PASS
|
|
docs: document effective token budget enforcement behavior 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.
|
🔬 Smoke Test Results
Overall: PASS PR: docs: sync schemas and specs with source changes by
|
Smoke Test Results
Overall: FAIL —
|
🏗️ Build Test Suite Results
Overall: 8/8 ecosystems passed — ✅ PASS
|
Schema/Spec Sync
Triggered by commit 433d9aa: fix: align ET budget error strings with gh-aw detection patterns (#2770)
Change
docs/awf-config.schema.jsonandsrc/awf-config-schema.json— Updated the description ofapiProxy.maxEffectiveTokens:"When reached, the API proxy rejects additional requests.""When exceeded, the API proxy rejects additional requests."This aligns the schema descriptions with the implementation change that renamed the event type from
effective_tokens_limit_reached→effective_tokens_limit_exceededincontainers/api-proxy/proxy-request.js. Both schema files are kept identical (except$id) as required bysrc/schema.test.ts.