Skip to content

docs(reference): generate Stacks Blockchain API pages from Hiro's OpenAPI spec #1891

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
cuevasm merged 2 commits into from
Oct 1, 2026
Merged

docs(reference): generate Stacks Blockchain API pages from Hiro's OpenAPI spec #1891

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9f91c0c
docs(reference): generate Stacks Blockchain API pages from Hiro's Ope…
werner-stacks Sep 30, 2026
867627c
docs(reference): keep Bitcoin Staking page on Hiro spec, drop empty M…
werner-stacks Oct 1, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions docs/reference/.gitbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,3 +15,11 @@ redirects:
example-contracts/bns: clarity/example-contracts/bns.md
example-contracts/multi-send: clarity/example-contracts/multi-send.md
example-contracts/stacking: clarity/example-contracts/stacking.md

# Stacks Blockchain API pages removed when the section moved to Hiro's spec (node RPC tags)
api/stacks-blockchain-api/mining: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/signers: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/atlas: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/stacker-db: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/fees: api/stacks-node-rpc/README.md
api/stacks-blockchain-api/bitcoin-staking: api/stacks-blockchain-api/README.md
14 changes: 1 addition & 13 deletions docs/reference/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -32,19 +32,7 @@
spec:
ref:
kind: openapi
spec: stacks-blockchain-api-dereferenced
```
* ```yaml
props:
models: false
downloadLink: false
grouping: by-tag
type: builtin:openapi
dependencies:
spec:
ref:
kind: openapi
spec: bitcoin-staking
spec: stacks-blockchain-api
```
* [Stacks Mesh API](api/stacks-mesh-api/README.md)
* ```yaml
Expand Down
Loading