From a18ec62aae8d776e83c4181c543b723e74822e1e Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" <41898282+github-actions[bot]@users.noreply.github.com> Date: Sat, 2 May 2026 12:39:00 +0000 Subject: [PATCH] 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> --- docs/awf-config-spec.md | 13 +++++++++++-- 1 file changed, 11 insertions(+), 2 deletions(-) diff --git a/docs/awf-config-spec.md b/docs/awf-config-spec.md index 3c46cb347..4f1413d26 100644 --- a/docs/awf-config-spec.md +++ b/docs/awf-config-spec.md @@ -11,8 +11,17 @@ This document defines the canonical configuration model for AWF (`awf`) and is i The machine-readable schema is published at: - `docs/awf-config.schema.json` — live schema (always reflects latest `main`) -- GitHub release asset `awf-config.schema.json` — versioned, stable URL per release - (e.g. `https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/awf-config.schema.json`) +- `docs/awf-config.v1.schema.json` — stable versioned copy of schema v1 (tracks `main`) +- GitHub release asset `awf-config.schema.json` — versioned stable URL per release (latest alias) +- GitHub release asset `awf-config.v1.schema.json` — versioned stable URL per release + (e.g. `https://github.com/github/gh-aw-firewall/releases/download/v0.23.1/awf-config.v1.schema.json`) + +External consumers (e.g. the `gh-aw` compiler) should pin to the versioned URL for stability: + +| Reference | URL | +|-----------|-----| +| Pinned to a specific release tag | `https://github.com/github/gh-aw-firewall/releases/download//awf-config.v1.schema.json` | +| Always-latest from `main` branch | `https://raw.githubusercontent.com/github/gh-aw-firewall/main/docs/awf-config.v1.schema.json` | ## 1. Conformance