Skip to content

Commit 8e2c381

Browse files
werner-stackswerner-stacks
authored
docs(reference): generate Stacks Blockchain API pages from Hiro's OpenAPI spec (#1891)
* docs(reference): generate Stacks Blockchain API pages from Hiro's OpenAPI spec * docs(reference): keep Bitcoin Staking page on Hiro spec, drop empty Models page
1 parent cbb0e1c commit 8e2c381

3 files changed

Lines changed: 74 additions & 13 deletions

File tree

‎docs/reference/.gitbook.yaml‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,3 +15,11 @@ redirects:
1515
example-contracts/bns: clarity/example-contracts/bns.md
1616
example-contracts/multi-send: clarity/example-contracts/multi-send.md
1717
example-contracts/stacking: clarity/example-contracts/stacking.md
18+
19+
# Stacks Blockchain API pages removed when the section moved to Hiro's spec (node RPC tags)
20+
api/stacks-blockchain-api/mining: api/stacks-node-rpc/README.md
21+
api/stacks-blockchain-api/signers: api/stacks-node-rpc/README.md
22+
api/stacks-blockchain-api/atlas: api/stacks-node-rpc/README.md
23+
api/stacks-blockchain-api/stacker-db: api/stacks-node-rpc/README.md
24+
api/stacks-blockchain-api/fees: api/stacks-node-rpc/README.md
25+
api/stacks-blockchain-api/models: api/stacks-blockchain-api/README.md

‎docs/reference/SUMMARY.md‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -23,29 +23,18 @@
2323
* [Pagination](api/stacks-blockchain-api/pagination.md)
2424
* [Nonce Handling](api/stacks-blockchain-api/nonce-handling.md)
2525
* [Requesting Proofs](api/stacks-blockchain-api/requesting-proofs.md)
26-
* ```yaml
27-
props:
28-
models: true
29-
downloadLink: false
30-
type: builtin:openapi
31-
dependencies:
32-
spec:
33-
ref:
34-
kind: openapi
35-
spec: stacks-blockchain-api-dereferenced
36-
```
3726
* ```yaml
3827
props:
3928
models: false
4029
downloadLink: false
41-
grouping: by-tag
4230
type: builtin:openapi
4331
dependencies:
4432
spec:
4533
ref:
4634
kind: openapi
47-
spec: bitcoin-staking
35+
spec: stacks-blockchain-api
4836
```
37+
* [Bitcoin Staking](api/stacks-blockchain-api/bitcoin-staking.md)
4938
* [Stacks Mesh API](api/stacks-mesh-api/README.md)
5039
* ```yaml
5140
props:

‎docs/reference/api/stacks-blockchain-api/bitcoin-staking.md‎

Lines changed: 64 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,64 @@
1+
---
2+
description: Endpoints for PoX-5 Bitcoin Staking positions, bonds, cycles, rewards and signers.
3+
---
4+
5+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/principals/{principal}/staking" method="get" %}
6+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
7+
{% endopenapi-operation %}
8+
9+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/principals/{principal}/staking/bonds" method="get" %}
10+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
11+
{% endopenapi-operation %}
12+
13+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds" method="get" %}
14+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
15+
{% endopenapi-operation %}
16+
17+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}" method="get" %}
18+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
19+
{% endopenapi-operation %}
20+
21+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/events" method="get" %}
22+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
23+
{% endopenapi-operation %}
24+
25+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/allowlist" method="get" %}
26+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
27+
{% endopenapi-operation %}
28+
29+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/allowlist/{principal}" method="get" %}
30+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
31+
{% endopenapi-operation %}
32+
33+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/registrations" method="get" %}
34+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
35+
{% endopenapi-operation %}
36+
37+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/bonds/{bond_index}/registrations/{principal}" method="get" %}
38+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
39+
{% endopenapi-operation %}
40+
41+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/cycles/{cycle_number}" method="get" %}
42+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
43+
{% endopenapi-operation %}
44+
45+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/cycles/{cycle_number}/signers" method="get" %}
46+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
47+
{% endopenapi-operation %}
48+
49+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/rewards" method="get" %}
50+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
51+
{% endopenapi-operation %}
52+
53+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers" method="get" %}
54+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
55+
{% endopenapi-operation %}
56+
57+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers/{principal}" method="get" %}
58+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
59+
{% endopenapi-operation %}
60+
61+
{% openapi-operation spec="stacks-blockchain-api" path="/extended/v3/staking/signers/{principal}/stakers" method="get" %}
62+
[OpenAPI stacks-blockchain-api](https://raw.githubusercontent.com/hirosystems/stacks-blockchain-api/main/openapi.yaml)
63+
{% endopenapi-operation %}
64+

0 commit comments

Comments
 (0)