Skip to content
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.

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

Clarify requirement for validator balances body #453

Merged
merged 5 commits into from
Aug 13, 2024
Merged
Changes from 1 commit
Commits
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
9 changes: 6 additions & 3 deletions apis/beacon/states/validator_balances.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ post:
description: |
Returns filterable list of validators balances.

Balances will be returned for all indices or public key that match known validators. If an index or public key does not
Balances will be returned for all indices or public keys that match known validators. If an index or public key does not
match any known validator, no balance will be returned but this will not cause an error. There are no guarantees for the
returned data in terms of ordering; the index is returned for each balance, and can be used to confirm for which inputs a
response has been returned.
Expand All @@ -90,8 +90,11 @@ post:
in: path
$ref: '../../../beacon-node-oapi.yaml#/components/parameters/StateId'
requestBody:
description: "An array of either hex encoded public key (any bytes48 with 0x prefix) or validator index"
required: false
description: |
Either hex encoded public key (any bytes48 with 0x prefix) or validator index.

If the supplied list is empty (i.e. the body is `[]`) then balances will be returned for all validators.
mcdee marked this conversation as resolved.
Show resolved Hide resolved
required: true
content:
application/json:
schema:
Expand Down
Loading