Repository navigation
Commit the generated OpenAPI spec and check it for drift - #837
Merged
Merged
Conversation
- `bun run generate:openapi` writes the spec the API serves at /openapi.json to apps/api/openapi.json, with the production API host as the default server. - `check:openapi` joins `check:drift`, so CI fails when the committed spec no longer matches the contract. - Tools that read the spec from the repository (the docs' API reference) can point at apps/api/openapi.json. Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Codex Review SummaryThis comment shows the latest Codex review activity on this pull request.
ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings. |
Contributor
Author
|
CI note: |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Summary
The rewrite builds its OpenAPI spec at runtime from the ts-rest contract and serves it at
/openapi.json, but no copy is committed. The old app committedapps/web/openapi/generated/openapi.json; it was removed with the platform migration (6587b560). Tools that read the spec from the repository, such as the API reference in the docs, have nothing to point at.bun run generate:openapi(inapps/api) writescreateOpenApiDocument("https://api.courselit.app")toapps/api/openapi.json. It's pretty-printed so diffs are reviewable.check:openapijoinscheck:drift, which the Platform conformance workflow already runs, so CI fails when a contract change isn't followed by a regenerated spec. The error says which command to run.apps/api/openapi.json(2.4 MB; Biome already skipped it for size, with a warning).docs/platform-based-rewrite.mdmentions the committed copy.The script follows
generate-auth-schema.mjs: the same write-or---checkshape and drift message.The spec: OpenAPI 3.0.2, 213 operations, 13 tags. The default server is
https://api.courselit.app, with the existing{protocol}://{host}variables.Testing
bun run check:driftpasses. A secondgenerate:openapirun leaves the file unchanged.bun test src/openapi.test.tspasses.🤖 Generated with Claude Code