Repository navigation
feat(education): complete P02d-4 public reads and contract checks #25
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.
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
Merged
Merged
Changes from all commits
Commits
Show all changes
32 commits
Select commit
Hold shift + click to select a range
2276edf
docs(roadmap): close merged P02d-3 and record the next packet
cemililik 100bfef
docs(roadmap): record final P02d-3 closeout reviews
cemililik cdca081
docs: align delivered theme and feature failure states
cemililik 9bc5911
docs: accept P02d-4 public read contracts
cemililik f79e4a4
docs(roadmap): clarify accepted SDK consumer ownership
cemililik 77b13f5
feat(kernel): enforce public read-only transaction frames
cemililik 75ff568
test(kernel): prove cleanup after server read-mode setup
cemililik 1020611
test(kernel): preserve the deliberate unsealed guard control
cemililik 248b5e3
fix(kernel): require host provenance for double-marked public reads
cemililik 97c8e73
feat(tenancy): serve read-only public site bootstrap
cemililik a81d726
test(api): close public dispatch and helper guard gaps
cemililik 51c3b64
test(api): fence generic helpers and secondary public dispatch
cemililik d49f7e9
test(api): retain generated action and lambda guard controls
cemililik 7a2073e
test(api): count every controller public dispatch
cemililik 6b8e743
test(api): count only public HTTP actions in dispatch census
cemililik b1bff6f
docs: close P02d-4 site bootstrap review loop
cemililik b5c3be2
feat(education): add anonymous public reads and scoped seek cursors
cemililik 6c09888
fix(education): refuse malformed Unicode cursors safely
cemililik 5d72c2f
docs: close P02d-4 Education read review loop
cemililik 5f49f62
feat(api): verify public contracts and activate OpenAPI CI
cemililik db9bab6
fix(api): close reviewed contract and compatibility gaps
cemililik 1a2730d
fix(api): preserve compatibility across references and parameters
cemililik 3fbe37e
fix(api): normalize recursive compatibility schemas safely
cemililik ef5c4d8
fix(api): bound recursive comparisons at every schema location
cemililik 0a14c74
docs(roadmap): close P02d-4 implementation and review records
cemililik 00e5f1a
docs(roadmap): record P02d-4 live checks and PR delivery
cemililik ddc96a5
docs: align the frontend scope summary with SDK delivery
cemililik 1d93838
docs: reconcile final public-read review notes with delivery
cemililik ef86f64
fix(education): bound public diagnostics and strengthen review proofs
cemililik 7e07613
docs(roadmap): record external review fix verification
cemililik 7ad4b91
docs: place provenance amendment and clarify test logging
cemililik f8adb11
ci: handle new-branch OpenAPI comparisons and align delivery
cemililik File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,52 @@ | ||
| # OpenAPI compatibility controls | ||
|
|
||
| [ADR-0024](../../../docs/decisions/0024-api-versioning-policy.md) owns the policy. | ||
| [P02d-4 G31](../../../docs/roadmap/phase-02d-walking-skeleton.md#openapi-sdk-and-required-check-plan) | ||
| owns pins, severity overrides, artifact contents and required-check rollout. | ||
|
|
||
| `fixtures/base.json` and `fixtures/cases.json` cover each representable policy row | ||
| with breaking mutations and nonbreaking controls. The runner checks a literal | ||
| non-empty census against the real pinned executable. It retains raw tool reports, | ||
| normalized reports and companion findings; no external references are allowed. | ||
|
|
||
| The pinned tool misses some root enum additions, open-to-closed enum changes and | ||
| numeric field type changes. It also rejects additions to an explicitly open | ||
| response enum. The companion walks reachable request/response schemas, including | ||
| local schema and Response/RequestBody/Parameter references. It refuses type changes, | ||
| closed enum additions and open enum closure/removal, and removes only matching | ||
| open enum lists for the tool. Fields, validators and other constraints remain. | ||
| Analysis finishes against immutable occurrences before normalizing separate copies; | ||
| an open reference never erases a closed consumer of the same component. Effective | ||
| parameters honor path inheritance and operation overrides; the CLI also flattens | ||
| parameters. Parameter/header schema and content forms are mirrored into temporary | ||
| request/response bodies the tool checks, preserving original metadata and recording | ||
| source locations. These policy-only paths exist in comparison artifacts, never in | ||
| the published snapshot or runtime routes. Controls cover field/validator changes, | ||
| equivalent relocation and both shared-reference key orders. Strengthening an output | ||
| guarantee is not an input-validator tightening and remains compatible. | ||
| Recursive edges stay in private schema copies identified by stable declaration | ||
| locations, so open enum additions and documentation edits remain compatible without | ||
| erasing closed consumers. Cycle and mixed open/closed controls cover this boundary, | ||
| including inline schemas and schemas declared inside Response components. | ||
| A combined open addition and field removal proves that normalization cannot hide | ||
| another breaking change. Current public enums are closed. A future open-set enum | ||
| still requires compatible generation and consumer proof before shipping. | ||
|
|
||
| Schema limits cannot describe every runtime rule or what a status means. | ||
| `PublicReadProtocolTests` and `PublicEducationHttpTests` prove locale, slug and | ||
| cursor grammar/multiplicity, unsupported locales and hidden-resource outcomes; | ||
| `PublicSiteHttpTests` proves site configuration/lifecycle status mapping. These | ||
| runtime cases complement documented validator/status mutations in the fixtures. | ||
|
|
||
| From the repository root, with the verified pinned executable: | ||
|
|
||
| ```sh | ||
| python3 scripts/test-openapi-ci.py | ||
| python3 scripts/openapi-policy.py --tool /path/to/oasdiff --fixtures --output /tmp/openapi-controls | ||
| python3 scripts/openapi-ci.py --base BASE_REF --head HEAD_REF --tool /path/to/oasdiff --output /tmp/openapi-diff | ||
| ``` | ||
|
|
||
| The installer is Linux AMD64 only and verifies the approved archive before | ||
| extracting/executing it. A workstation can pass a separately checksum-verified | ||
| executable of the same pinned version. The first baseline is proved by building | ||
| and serving the verified base Program; a missing file alone is insufficient. |
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.