Merge pull request #173 from mcdee/clarify-missing-items

Add note regarding invalid vs not found.
ethereum · Oct 15, 2021 · f68bba8 · f68bba8
2 parents 22b0d75 + 6ebea8e
commit f68bba8
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 2 deletions.
diff --git a/apis/beacon/states/validator_balances.yaml b/apis/beacon/states/validator_balances.yaml
@@ -1,7 +1,13 @@
 get:
   operationId: "getStateValidatorBalances"
   summary: "Get validator balances from state"
-  description: "Returns filterable list of validator balances."
+  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
+    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 and is returned for each balance, and can be used to confirm for which inputs a
+    response has been returned.
   tags:
     - Beacon
   parameters:

diff --git a/apis/beacon/states/validators.yaml b/apis/beacon/states/validators.yaml
@@ -1,7 +1,13 @@
 get:
   operationId: "getStateValidators"
   summary: "Get validators from state"
-  description: "Returns filterable list of validators with their balance, status and index."
+  description: |
+    Returns filterable list of validators with their balance, status and index.
+
+    Information will be returned for all indices or public key that match known validators.  If an index or public key does not
+    match any known validator, no information will be returned but this will not cause an error.  There are no guarantees for the
+    returned data in terms of ordering; both the index and public key are returned for each validator, and can be used to confirm
+    for which inputs a response has been returned.
   tags:
     - Beacon
   parameters: