Skip to content

docs: refresh Stacks Blockchain API reference to latest OpenAPI spec#1147

Merged
rafa-stacks merged 2 commits into
mainfrom
docs/refresh-stacks-api-spec
Jul 21, 2026
Merged

docs: refresh Stacks Blockchain API reference to latest OpenAPI spec#1147
rafa-stacks merged 2 commits into
mainfrom
docs/refresh-stacks-api-spec

Conversation

@rafa-stacks

Copy link
Copy Markdown
Collaborator

What & why

Refreshes the Stacks Blockchain API reference against the latest stacks-blockchain-api master OpenAPI spec. Since the last sync (#1144), the spec dropped from 82 to 78 endpoints, so a few documented endpoints no longer exist and are removed here to keep the reference 1:1 with the spec.

Changes

Regenerated the spec and reconciled the English reference tree — this round is pure removals (0 added, 4 removed):

  • Removed the Microblocks group entirely (all 3 endpoints no longer in the spec): get-microblock-list, get-microblock-by-hash, get-unanchored-txs. Deleted the folder and its meta.json.
  • Removed one faucet endpointGET /extended/v1/faucets/btc/{address} (faucets/get-btc-balance.mdx) — and updated faucets/meta.json.

Net: 4 .mdx deletions + the Microblocks meta.json + the faucets meta.json edit (58 deletions total).

Verification

  • Zero drift: documented pages now match the 78 spec operations 1:1.
  • Every meta.json ↔ file is consistent; no lingering microblocks references remain.
  • fumadocs-mdx compiles cleanly.
  • Dev-server render check: removed pages 404, remaining faucet pages 200.

Reviewer note

Only the English reference tree is updated (the Spanish tree is separately maintained). openapi/ and generated/ are gitignored (rebuilt at build time), so no regenerated artifacts appear in this diff.

🤖 Generated with Claude Code

@vercel

vercel Bot commented Jul 21, 2026

Copy link
Copy Markdown
Contributor

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
hiro-systems-docs Ready Ready Preview Jul 21, 2026 5:01pm

Request Review

@rafa-stacks
rafa-stacks merged commit 38cf756 into main Jul 21, 2026
1 of 2 checks passed
@rafa-stacks
rafa-stacks deleted the docs/refresh-stacks-api-spec branch July 21, 2026 17:15
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.

1 participant