Skip to content

Commit

Permalink
Update endpoints tags, operationId and summary according to the spec (#…
Browse files Browse the repository at this point in the history
  • Loading branch information
zilm13 authored Mar 25, 2024
1 parent 1cdc8d0 commit acb4623
Show file tree
Hide file tree
Showing 85 changed files with 142 additions and 142 deletions.
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getAttestations",
"summary" : "Get attestations",
"operationId" : "getPoolAttestations",
"summary" : "Get Attestations from operations pool",
"description" : "Retrieves attestations known by the node but not necessarily incorporated into any block.",
"parameters" : [ {
"name" : "slot",
Expand Down Expand Up @@ -58,8 +58,8 @@
},
"post" : {
"tags" : [ "Beacon", "Validator Required Api" ],
"operationId" : "postAttestation",
"summary" : "Submit signed attestations",
"operationId" : "submitPoolAttestations",
"summary" : "Submit Attestation objects to node",
"description" : "Submit signed attestations to the beacon node to be validated and submitted if valid.\n\nThis endpoint does not protected against slashing.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getAttesterSlashings",
"summary" : "Get Attester Slashings",
"operationId" : "getPoolAttesterSlashings",
"summary" : "Get AttesterSlashings from operations pool",
"description" : "Retrieves attester slashings known by the node but not necessarily incorporated into any block.",
"responses" : {
"200" : {
Expand Down Expand Up @@ -39,8 +39,8 @@
},
"post" : {
"tags" : [ "Beacon" ],
"operationId" : "postAttesterSlashing",
"summary" : "Submit attester slashing object",
"operationId" : "submitPoolAttesterSlashings",
"summary" : "Submit AttesterSlashing object to node's pool",
"description" : "Submits attester slashing object to node's pool and if passes validation node MUST broadcast it to network.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"post" : {
"tags" : [ "Beacon" ],
"operationId" : "postBlsToExecutionChange",
"operationId" : "submitPoolBLSToExecutionChange",
"summary" : "Submit SignedBLSToExecutionChange object to node's pool",
"description" : "Submits SignedBLSToExecutionChange object to node's pool and if passes validation node MUST broadcast it to network.",
"requestBody" : {
Expand Down Expand Up @@ -45,7 +45,7 @@
},
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getBlsToExecutionChanges",
"operationId" : "getPoolBLSToExecutionChanges",
"summary" : "Get SignedBLSToExecutionChange from operations pool",
"description" : "Retrieves BLS to execution changes known by the node but not necessarily incorporated into any block",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getProposerSlashings",
"summary" : "Get proposer slashings",
"operationId" : "getPoolProposerSlashings",
"summary" : "Get ProposerSlashings from operations pool",
"description" : "Retrieves proposer slashings known by the node but not necessarily incorporated into any block.",
"responses" : {
"200" : {
Expand Down Expand Up @@ -39,8 +39,8 @@
},
"post" : {
"tags" : [ "Beacon" ],
"operationId" : "postProposerSlashing",
"summary" : "Submit proposer slashing object",
"operationId" : "submitPoolProposerSlashings",
"summary" : "Submit ProposerSlashing object to node's pool",
"description" : "Submits proposer slashing object to node's pool and, if it passes validation, the node MUST broadcast it to network.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"post" : {
"tags" : [ "Beacon", "Validator Required Api" ],
"operationId" : "postSyncCommittees",
"summary" : "Submit sync committee messages to node",
"operationId" : "submitPoolSyncCommitteeSignatures",
"summary" : "Submit sync committee signatures to node",
"description" : "Submits sync committee message objects to the node.\n\nSync committee messages are not present in phase0, but are required for Altair networks.\n\nIf a sync committee message is validated successfully the node MUST publish that sync committee message on all applicable subnets.\n\nIf one or more sync committee messages fail validation the node MUST return a 400 error with details of which sync committee messages have failed, and why.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getVoluntaryExits",
"summary" : "Get signed voluntary exits",
"operationId" : "getPoolVoluntaryExits",
"summary" : "Get SignedVoluntaryExit from operations pool",
"description" : "Retrieves voluntary exits known by the node but not necessarily incorporated into any block.",
"responses" : {
"200" : {
Expand Down Expand Up @@ -39,8 +39,8 @@
},
"post" : {
"tags" : [ "Beacon" ],
"operationId" : "postVoluntaryExit",
"summary" : "Submit signed voluntary exit",
"operationId" : "submitPoolVoluntaryExit",
"summary" : "Submit SignedVoluntaryExit object to node's pool",
"description" : "Submits signed voluntary exit object to node's pool and if it passes validation node MUST broadcast it to network.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"Rewards"
],
"operationId": "getAttestationsRewards",
"summary": "Get Attestations Rewards",
"summary": "Get attestations rewards",
"description": "Retrieve attestation reward info for validators specified by array of public keys or validator index. If no array is provided, return reward info for every validator.",
"parameters": [
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Beacon", "Rewards"],
"operationId" : "getBlockRewards",
"summary" : "Get Block Rewards",
"summary" : "Get block rewards",
"description" : "Retrieve block reward info for a single block.",
"parameters" : [ {
"name" : "block_id",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"post" : {
"tags" : [ "Beacon", "Rewards" ],
"operationId" : "getSyncCommitteeRewards",
"summary" : "Get Sync Committee Rewards",
"summary" : "Get sync committee rewards",
"description" : "Retrieves rewards info for sync committee members specified by array of public keys or validator index. If no array is provided, return reward info for every committee member.",
"parameters" : [ {
"name" : "block_id",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getStateCommittees",
"summary" : "Get committees at state",
"operationId" : "getEpochCommittees",
"summary" : "Get all committees for a state.",
"description" : "Retrieves the committees for the given state.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon", "Validator Required Api" ],
"operationId" : "getSateFork",
"summary" : "Get state fork",
"operationId" : "getStateFork",
"summary" : "Get Fork object for requested state",
"description" : "Returns Fork object for state with given 'state_id'.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getStateRandao",
"summary" : "Get state RANDAO",
"summary" : "Get the RANDAO mix for some epoch in a specified state.",
"description" : "Fetch the RANDAO mix for the requested epoch from the state identified by `state_id`.\n\nIf an epoch is not specified then the RANDAO mix for the state's current epoch will be returned.\n\nBy adjusting the `state_id` parameter you can query for any historic value of the RANDAO mix. Ordinarily states from the same epoch will mutate the RANDAO mix for that epoch as blocks are applied.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Beacon" ],
"operationId" : "getStateRoot",
"summary" : "Get state root",
"summary" : "Get state SSZ HashTreeRoot",
"description" : "Calculates HashTreeRoot for state with given 'state_id'. If stateId is root, same value will be returned.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Beacon", "Validator Required Api" ],
"operationId" : "getStateSyncCommittees",
"summary" : "Get sync committees",
"tags" : [ "Beacon" ],
"operationId" : "getEpochSyncCommittees",
"summary" : "Get sync committees for a state.",
"description" : "Retrieves the sync committees for the given state.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Beacon", "Validator Required Api" ],
"operationId" : "getStateValidator",
"summary" : "Get validator from state",
"summary" : "Get validator from state by id",
"description" : "Retrieves data about the given peer.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Builder" ],
"operationId" : "GetExpectedWithdrawals",
"summary" : "Get Expected Withdrawals",
"operationId" : "getNextWithdrawals",
"summary" : "Get the withdrawals that are to be included for the block built on the specified state.",
"description" : "Get the withdrawals computed from the specified state, that will be included in the block \n that gets built on the specified state.",
"parameters" : [ {
"name" : "state_id",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"get" : {
"tags" : [ "Config" ],
"operationId" : "getDepositContractAddress",
"operationId" : "getDepositContract",
"summary" : "Get deposit contract address",
"description" : "Retrieve deposit contract address and genesis fork version.",
"responses" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Config" ],
"operationId" : "getScheduledForks",
"summary" : "Get scheduled forks",
"operationId" : "getForkSchedule",
"summary" : "Get scheduled upcoming forks.",
"description" : "Retrieve all scheduled upcoming forks this node is aware of.",
"responses" : {
"200" : {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Config", "Validator Required Api" ],
"operationId" : "getSpec",
"summary" : "Get spec params",
"summary" : "Get spec params.",
"description" : "Retrieve specification configuration used on this node.",
"responses" : {
"200" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Node" ],
"operationId" : "GetNodeHealth",
"summary" : "Get node health",
"operationId" : "getHealth",
"summary" : "Get health check",
"description" : "Returns node health status in http status codes. Useful for load balancers.",
"parameters" : [ {
"name" : "syncing_status",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Node" ],
"operationId" : "getNodePeers",
"summary" : "Get node peers",
"operationId" : "getPeers",
"summary" : "Get node network peers",
"description" : "Retrieves data about the node's network peers.",
"responses" : {
"200" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"get" : {
"tags" : [ "Node" ],
"operationId" : "getNodePeer",
"operationId" : "getPeer",
"summary" : "Get node peer",
"description" : "Retrieves data about the given peer.",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"get" : {
"tags" : [ "Node", "Validator Required Api" ],
"operationId" : "getNodeSyncingStatus",
"operationId" : "getSyncingStatus",
"summary" : "Get node syncing status",
"description" : "Requests the beacon node to describe if it's currently syncing or not, and if it is, what block it is up to.",
"responses" : {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Node" ],
"operationId" : "getNodeVersion",
"summary" : "Get node version",
"summary" : "Get version string of the running beacon node.",
"description" : "similar to [HTTP User-Agent](https://tools.ietf.org/html/rfc7231#section-5.5.3).",
"responses" : {
"200" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"post" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "postAggregateAndProofs",
"summary" : "Publish aggregate and proofs",
"operationId" : "publishAggregateAndProofs",
"summary" : "Publish multiple aggregate and proofs",
"description" : "Verifies given aggregate and proofs and publishes it on appropriate gossipsub topic.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"get" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "getAggregateAttestation",
"summary" : "Get aggregated attestations",
"operationId" : "getAggregatedAttestation",
"summary" : "Get aggregated attestation",
"description" : "Aggregates all attestations matching given attestation data root and slot.",
"parameters" : [ {
"name" : "attestation_data_root",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"get" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "getAttestationData",
"operationId" : "produceAttestationData",
"summary" : "Produce an AttestationData",
"description" : "Requests that the beacon node produce an AttestationData.",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"post" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "postSubscribeToBeaconCommitteeSubnet",
"summary" : "Subscribe to a committee subnet",
"operationId" : "prepareBeaconCommitteeSubnet",
"summary" : "Signal beacon node to prepare for a committee subnet",
"description" : "After Beacon node receives this request, search using discv5 for peers related to this subnet and replace current peers with those ones if necessary If validator is_aggregator, beacon node must:\n- announce subnet topic subscription on gossipsub\n- aggregate attestations received on that subnet\n",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"get" : {
"tags" : [ "Validator", "Validator Required Api"],
"operationId" : "getNewBlindedBlock",
"operationId" : "produceBlindedBlock",
"summary" : "Produce unsigned blinded block",
"description" : "Requests a beacon node to produce a valid blinded block, which can then be signed by a validator. A blinded block is a block with only a transactions root, rather than a full transactions list.\n\nMetadata in the response indicates the type of block produced, and the supported types of block will be added to as forks progress.\n\nPre-Bellatrix, this endpoint will return a `BeaconBlock`.",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"post" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "postContributionAndProofs",
"summary" : "Publish contribution and proofs",
"operationId" : "publishContributionAndProofs",
"summary" : "Publish multiple contribution and proofs",
"description" : "Verifies given sync committee contribution and proofs and publishes on appropriate gossipsub topics.",
"requestBody" : {
"content" : {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"post" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "postAttesterDuties",
"operationId" : "getAttesterDuties",
"summary" : "Get attester duties",
"description" : "Requests the beacon node to provide a set of attestation duties, which should be performed by validators, for a particular epoch. Duties should only need to be checked once per epoch, however a chain reorganization (of > MIN_SEED_LOOKAHEAD epochs) could occur, resulting in a change of duties. For full safety, you should monitor head events and confirm the dependent root in this response matches:\n- event.previous_duty_dependent_root when `compute_epoch_at_slot(event.slot) == epoch`\n- event.current_duty_dependent_root when `compute_epoch_at_slot(event.slot) + 1 == epoch`\n- event.block otherwise\n\nThe dependent_root value is `get_block_root_at_slot(state, compute_start_slot_at_epoch(epoch - 1) - 1)` or the genesis block root in the case of underflow.",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"get" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "getProposerDuties",
"summary" : "Get proposer duties",
"summary" : "Get block proposers duties",
"description" : "Request beacon node to provide all validators that are scheduled to propose a block in the given epoch.\n\nDuties should only need to be checked once per epoch, however a chain reorganization could occur that results in a change of duties. For full safety, you should monitor head events and confirm the dependent root in this response matches:\n- event.current_duty_dependent_root when `compute_epoch_at_slot(event.slot) == epoch`\n- event.block otherwise\n\nThe dependent_root value is `get_block_root_at_slot(state, compute_start_slot_at_epoch(epoch) - 1)` or the genesis block root in the case of underflow.",
"parameters" : [ {
"name" : "epoch",
Expand Down
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"post" : {
"tags" : [ "Validator", "Validator Required Api" ],
"operationId" : "postSyncDuties",
"operationId" : "getSyncCommitteeDuties",
"summary" : "Get sync committee duties",
"description" : "Requests the beacon node to provide a set of sync committee duties",
"parameters" : [ {
Expand Down
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"post" : {
"tags" : [ "Validator" ],
"operationId" : "postValidatorLiveness",
"summary" : "Get Validator Liveness",
"operationId" : "getLiveness",
"summary" : "Indicates if a validator has been observed on the network",
"description" : "Requests the beacon node to indicate if a validator has been observed to be live in a given epoch. The beacon node might detect liveness by observing messages from the validator on the network, in the beacon chain, from its API or from any other source. It is important to note that the values returned by the beacon node are not canonical; they are best-effort and based upon a subjective view of the network.",
"parameters" : [ {
"name" : "epoch",
Expand Down
Loading

0 comments on commit acb4623

Please sign in to comment.