Skip to content

Commit e857672

Browse files
committed
docs: correct multi-example openapi.yaml
1 parent b396798 commit e857672

File tree

1 file changed

+10
-9
lines changed

1 file changed

+10
-9
lines changed

docs/rpc/openapi.yaml

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -685,17 +685,18 @@ paths:
685685
Fetch sortition information about a burnchain block. If the `lookup_kind` and `lookup` parameters are empty, it will return information about the latest burn block.
686686
responses:
687687
"200":
688-
description: Information for the given reward cycle
688+
description: Information for the burn block or in the case of `latest_and_last`, multiple burn blocks
689689
content:
690690
application/json:
691-
example:
692-
$ref: ./api/core-node/get_sortitions.example.json
693-
"200":
694-
description: Sortition information about the latest burn block with a winning miner, and the previous such burn block.
695-
content:
696-
application/json:
697-
example:
698-
$ref: ./api/core-node/get_sortitions_latest_and_prior.example.json
691+
examples:
692+
Latest:
693+
description: A single element list is returned when just one sortition is requested
694+
value:
695+
$ref: ./api/core-node/get_sortitions.example.json
696+
LatestAndLast:
697+
description: Sortition information about the latest burn block with a winning miner, and the previous such burn block.
698+
value:
699+
$ref: ./api/core-node/get_sortitions_latest_and_prior.example.json
699700
parameters:
700701
- name: lookup_kind
701702
in: path

0 commit comments

Comments
 (0)