From 5524f75f025d1a4cb407f78860816f7459793c9f Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sun, 10 May 2026 00:05:55 +0000 Subject: [PATCH] [docs] Document AWF JSONL schema URLs in artifacts reference Adds a JSON Schemas subsection under firewall-audit-logs that points to the versioned audit.schema.json and token-usage.schema.json published by github/gh-aw-firewall, addressing the documentation gap from #29841. Co-Authored-By: Claude Opus 4.7 (1M context) --- docs/src/content/docs/reference/artifacts.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/docs/src/content/docs/reference/artifacts.md b/docs/src/content/docs/reference/artifacts.md index d2885aa3c71..3e5be9a1082 100644 --- a/docs/src/content/docs/reference/artifacts.md +++ b/docs/src/content/docs/reference/artifacts.md @@ -112,6 +112,17 @@ gh run download -n firewall-audit-logs cat firewall-audit-logs/api-proxy-logs/token-usage.jsonl ``` +### JSON Schemas + +The JSONL files in this artifact are described by versioned JSON Schemas published by [github/gh-aw-firewall](https://github.com/github/gh-aw-firewall). Each record includes a `_schema` field (for example `"audit/v0.26.0"`) so consumers can identify the record type and AWF version. + +| File | Schema asset | Pinned URL | +|------|--------------|------------| +| `audit.jsonl` | `audit.schema.json` | `https://github.com/github/gh-aw-firewall/releases/download//audit.schema.json` | +| `api-proxy-logs/token-usage.jsonl` | `token-usage.schema.json` | `https://github.com/github/gh-aw-firewall/releases/download//token-usage.schema.json` | + +Use `releases/latest/download/` in place of a specific tag to track the most recent published release. Schemas are versioned by AWF release tag; consumers should match `_schema` by prefix (for example `_schema.startsWith("audit/")`) so additive changes remain non-breaking. + ## `agent` The unified `agent` artifact contains all agent job outputs.