Skip to content

2404 stack 2 commit openapi spec - #2444

Open
correct-horse-battery-bench wants to merge 1 commit into
2404-stack-1-openapi-generator-and-lintfrom
2404-stack-2-commit-generated-spec
Open

2404 stack 2 commit openapi spec#2444
correct-horse-battery-bench wants to merge 1 commit into
2404-stack-1-openapi-generator-and-lintfrom
2404-stack-2-commit-generated-spec

Conversation

@correct-horse-battery-bench

@correct-horse-battery-bench correct-horse-battery-bench commented Aug 18, 2026

Copy link
Copy Markdown
Contributor

Check in generated openapi spec and make sure it is up to date.

@correct-horse-battery-bench correct-horse-battery-bench changed the title Commit the generated OpenAPI spec at the repository root 2404 stack 2 commit openapi spec Aug 18, 2026
@correct-horse-battery-bench
correct-horse-battery-bench force-pushed the 2404-stack-2-commit-generated-spec branch from 4e9c681 to 792f942 Compare August 18, 2026 07:44
@correct-horse-battery-bench
correct-horse-battery-bench marked this pull request as ready for review August 18, 2026 14:10
The spec existed only inside the lint job, which downloaded it from a freshly
started server and threw it away afterwards. Nothing in the repository showed
what the API answers, so a change to a schema was invisible in review and the
document that failed a lint run could not be reproduced from a checkout.

openapi.json now carries the generated document (170 paths, 286 schemas),
produced by `php ci/tools/generate-openapi.php --pretty` and marked
linguist-generated so it collapses in review.

The lint job downloads the served spec beside the committed one and compares the
two first, then lints the file the repository carries. A drift fails with the
diff and the command that regenerates the spec, so the committed document cannot
fall behind the backend unnoticed. Both specs are normalised with jq before the
comparison, so a difference in key order or formatting is not reported as drift.
@correct-horse-battery-bench
correct-horse-battery-bench force-pushed the 2404-stack-2-commit-generated-spec branch from 792f942 to c300836 Compare August 18, 2026 14:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants