Skip to content

Commit a18ec62

Browse files
docs: add awf-config.v1.schema.json references to config spec
The feat #2384 introduced a versioned awf-config.v1.schema.json schema file alongside the existing awf-config.schema.json. Update the AWF Configuration Specification to document both files and add a stable pinning reference table consistent with docs/releasing.md. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
1 parent 08cd698 commit a18ec62

1 file changed

Lines changed: 11 additions & 2 deletions

File tree

docs/awf-config-spec.md

Lines changed: 11 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -11,8 +11,17 @@ This document defines the canonical configuration model for AWF (`awf`) and is i
1111
The machine-readable schema is published at:
1212

1313
- `docs/awf-config.schema.json` — live schema (always reflects latest `main`)
14-
- GitHub release asset `awf-config.schema.json` — versioned, stable URL per release
15-
(e.g. `https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/awf-config.schema.json`)
14+
- `docs/awf-config.v1.schema.json` — stable versioned copy of schema v1 (tracks `main`)
15+
- GitHub release asset `awf-config.schema.json` — versioned stable URL per release (latest alias)
16+
- GitHub release asset `awf-config.v1.schema.json` — versioned stable URL per release
17+
(e.g. `https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/awf-config.v1.schema.json`)
18+
19+
External consumers (e.g. the `gh-aw` compiler) should pin to the versioned URL for stability:
20+
21+
| Reference | URL |
22+
|-----------|-----|
23+
| Pinned to a specific release tag | `https://github.com/github/gh-aw-firewall/releases/download/<tag>/awf-config.v1.schema.json` |
24+
| Always-latest from `main` branch | `https://github.com/__raw/github/gh-aw-firewall/main/docs/awf-config.v1.schema.json` |
1625

1726
## 1. Conformance
1827

0 commit comments

Comments
 (0)