feat: serve dashboard-api docs at /dashboard-api/#456
Merged
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Adds a `rewrites` rule routing `docs.blockfrost.io/dashboard-api/*` to a standalone Vercel project hosting the Blockfrost Dashboard API documentation, plus a 308 redirect from the bare `/dashboard-api` to the trailing-slash form (mirroring the existing `/midnight` pattern). An explicit rewrite for the trailing-slash index is included separately because Vercel's path matcher treats `:path*` as one-or-more in practice, so the bare `/dashboard-api/` would otherwise 404. This repo only hosts the path under the shared `docs.blockfrost.io` domain; the spec and Scalar build live in the separate project and deploy independently. README updated under Development with a short note on the architecture. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
slowbackspace
force-pushed
the
add-dashboard-api-docs-rewrite
branch
from
abd6445 to
fac4433
Compare
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
1 participant
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
docs.blockfrost.io/dashboard-api/*→ the standalone Vercel project that hosts the Blockfrost Dashboard API documentation. The spec and Scalar build live separately and deploy independently; this PR makes the openapi project host the path under the shareddocs.blockfrost.iodomain./dashboard-api/, because Vercel's path matcher treats:path*as one-or-more in practice — without it, the bare index returns 404./dashboard-api→/dashboard-api/, mirroring the existing/midnightpattern.Why
Avoids copy-pasting the dashboard-api spec into this repo each release. Each service owns its spec and its Scalar build; this repo just owns the host.
Test plan
/dashboard-api/renders Scalar docs after the index-path fixcurl -I https://docs.blockfrost.io/dashboard-api/→ 200curl -I https://docs.blockfrost.io/dashboard-api→ 308 →/dashboard-api/curl -I https://docs.blockfrost.io/dashboard-api/openapi.yaml→ 200/midnight/,/(main openapi docs)Notes
x-vercel-enable-rewrite-caching: 1header for the/dashboard-api/:path*source.🤖 Generated with Claude Code