Add draft API design guide and conformance tooling - #17

Open

jeremi wants to merge 19 commits into

GovStackWorkingGroup:mainfrom

jeremi:feat/api-design-guide-linter

Commits on Jul 10, 2026

docs: add cross-BB API design guide (draft) as standalone GitBook
jeremi
committed
fed99cb
feat: add GovStack Spectral ruleset and API lint tooling
jeremi
committed
6ad82fc

Commits on Aug 4, 2026

docs: extend API design guide to 171 rules
jeremi
committed
c1c9544
feat: add reference API example and vendored common components
jeremi
committed
fbf09af
feat: extend Spectral ruleset to 130 rules and add surface discovery
jeremi
committed
35101e4
docs: rewrite BB spec template around a reference example
jeremi
committed
071dd12
fix: repoint reverse-DNS namespace to global.govstack and docs to govstack.global
jeremi
committed
2bb0111
docs: stop citing an unpublished cross-BB audit as the evidence base
jeremi
committed
baed8c0
fix: qualify AsyncAPI 3.1.0 alongside 3.0.0 in 3.1
jeremi
committed
e013106
fix: state 17.4 against the AsyncAPI 3 Parameter Object
jeremi
committed
98d1146
fix: carve out of 9.7 the enum values other rules mandate
jeremi
committed
19fd76d
fix: exempt the 5.9 operational endpoints from 5.1 and 18.2
jeremi
committed
4ab4365
fix: reconcile guide rules with the immutable cross-functional requirements
jeremi
committed
9d1ab6d
docs: point the shipped rulesets at conventions an adopter can reach
jeremi
committed
c158081
fix: make the event-signing and common-error rules satisfiable
jeremi
committed
3ddd28d
fix: close the gaps an external adopter hit applying the guide
jeremi
committed
1522904

Commits on Aug 6, 2026

Simplify API design guide and template contracts
jeremi
committed
85f7e7e
Simplify API guide conformance model
jeremi
committed
30b6476

Commits on Aug 10, 2026

Narrow API guide template integration
jeremi
committed
8eb6b3e