Skip to content

docs: sync schemas and specs with source changes #4752

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
lpcox merged 2 commits into from
Jun 11, 2026
Merged

docs: sync schemas and specs with source changes #4752

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1f959d7
docs: add blocked-request-diag.jsonl to Runtime JSONL Schemas table
github-actions[bot] Jun 11, 2026
91bc423
docs: clarify Runtime JSONL Schemas intro to cover inline-documented …
Copilot Jun 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions docs/awf-config-spec.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1395,8 +1395,9 @@ Each record follows the `blocked-request-diag/v<version>` schema:

## Runtime JSONL Schemas

AWF emits structured JSONL artifact files at runtime. Each record type has
a corresponding JSON Schema in the `schemas/` directory:
AWF emits structured JSONL artifact files at runtime. Most record types have
a corresponding JSON Schema in the `schemas/` directory; opt-in diagnostic
formats are documented inline in this spec instead:

| Schema | JSONL file | Description |
|--------|------------|-------------|
Expand All @@ -1405,6 +1406,7 @@ a corresponding JSON Schema in the `schemas/` directory:
| [`schemas/otel-span.schema.json`](../schemas/otel-span.schema.json) | `otel.jsonl` | OpenTelemetry span records emitted by the local file exporter |
| [`schemas/cli-proxy-access.schema.json`](../schemas/cli-proxy-access.schema.json) | `access.jsonl` (cli-proxy) | CLI proxy request audit records |
| *(inline, see §13.2)* | `token-diag.jsonl` | Model alias resolution steps and diagnostic events (opt-in via `apiProxy.logging.debugTokens`) |
| *(inline, see §13.6)* | `blocked-request-diag.jsonl` | Body-shape diagnostics for guard-blocked requests (opt-in via `apiProxy.diagnostics.captureBlockedRequests`) |

### Versioning

Expand Down
Loading