docs(api): publish MyFestival OpenAPI spec via Redoc at /api-docs/ - #428
Merged
Conversation
Adds a Redoc-rendered API docs page at /api-docs/ in the Cloudflare Pages deployment. The OpenAPI spec is generated from proto at build time (not committed), consistent with the proto-in-CI pattern from #426. - web/api-docs/index.html: Redoc page loading openapi.yaml from jsDelivr CDN - web/api-docs/.gitignore: openapi.yaml is generated, not committed - web/_headers: /api-docs/* CSP override allowing cdn.jsdelivr.net for Redoc - ci.yml build-web: buf generate + copy openapi.yaml before flutter build - mise.dev.toml proto:generate: also copies to web/api-docs/ for local dev https://claude.ai/code/session_015uTnGiC56cEELZMH2cQQU4
Codecov Report✅ All modified and coverable lines are covered by tests. 📢 Thoughts on this report? Let us know! |
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-festival-api-spec-doc.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
Cloudflare Pages does not resolve implicit directory indexes before evaluating _redirects rewrite rules, so /api-docs/ was being caught by /* /index.html 200 before the Redoc page could be served. Adding explicit /api-docs and /api-docs/ rules before the catch-all routes those two paths to /api-docs/index.html directly. https://claude.ai/code/session_015uTnGiC56cEELZMH2cQQU4
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-festival-api-spec-doc.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
Downloading redoc.standalone.js at build time (CI) and local dev (proto:generate) so it is served from 'self', which the existing Flutter CSP already allows. Removes the /api-docs/* CSP override that was added to permit cdn.jsdelivr.net. https://claude.ai/code/session_015uTnGiC56cEELZMH2cQQU4
Contributor
🚀 Cloudflare Pages PreviewYour preview deployment is ready! Preview URL: https://claude-festival-api-spec-doc.staging-cambeerfestival.pages.dev This preview will be automatically updated when you push new commits to this PR. |
Merged
Merged
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
2 participants
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.
Adds a Redoc-rendered API docs page at /api-docs/ in the Cloudflare Pages
deployment. The OpenAPI spec is generated from proto at build time (not
committed), consistent with the proto-in-CI pattern from #426.
https://claude.ai/code/session_015uTnGiC56cEELZMH2cQQU4