Skip to content

[docs] docs: add awf-config.v1.schema.json references to config spec #2393

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

Closed
github-actions wants to merge 1 commit into from
Closed

[docs] docs: add awf-config.v1.schema.json references to config spec #2393

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 11 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 @@ -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/<tag>/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

Expand Down
Loading