Skip to content

Commit c0f53ff

Browse files
committed
added /v3/blocks/height/{block_height} in openapi definitions
1 parent 5cc1a1c commit c0f53ff

File tree

1 file changed

+34
-0
lines changed

1 file changed

+34
-0
lines changed

docs/rpc/openapi.yaml

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -627,6 +627,40 @@ paths:
627627
content:
628628
application/text-plain: {}
629629

630+
/v3/blocks/height/{block_height}:
631+
get:
632+
summary: Fetch a Nakamoto block by its height and optional tip
633+
tags:
634+
- Blocks
635+
operationId: get_block_v3_by_height
636+
description:
637+
Fetch a Nakamoto block by its height and optional tip.
638+
parameters:
639+
- name: block_height
640+
in: path
641+
description: The block's height
642+
required: true
643+
schema:
644+
type: integer
645+
- name: tip
646+
in: query
647+
schema:
648+
type: string
649+
description: The Stacks chain tip to query from. If tip == latest or empty, the query will be run
650+
from the latest known tip.
651+
responses:
652+
"200":
653+
description: The raw SIP-003-encoded block will be returned.
654+
content:
655+
application/octet-stream:
656+
schema:
657+
type: string
658+
format: binary
659+
"404":
660+
description: The block could not be found
661+
content:
662+
application/text-plain: {}
663+
630664
/v3/tenures/info:
631665
get:
632666
summary: Fetch metadata about the ongoing Nakamoto tenure

0 commit comments

Comments
 (0)