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 the consensus version headers #470

Merged
merged 5 commits into from
Sep 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
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
1 change: 1 addition & 0 deletions apis/beacon/blocks/attestations.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@ get:
headers:
Eth-Consensus-Version:
$ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
description: "The active consensus version to which the attestations belong."
content:
application/json:
schema:
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/blocks/blinded_blocks.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: true
name: Eth-Consensus-Version
description: "Version of the block being submitted."
description: "The active consensus version to which the block being submitted belongs."
requestBody:
description: "The `SignedBlindedBeaconBlock` object composed of `BlindedBeaconBlock` object (produced by beacon node) and validator signature."
required: true
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/blocks/blinded_blocks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: false
name: Eth-Consensus-Version
description: "Version of the block being submitted, if using SSZ encoding."
description: "The active consensus version to which the block being submitted belongs."
requestBody:
description: "The `SignedBlindedBeaconBlock` object composed of `BlindedBeaconBlock` object (produced by beacon node) and validator signature."
required: true
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/blocks/blocks.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: true
name: Eth-Consensus-Version
description: "Version of the block being submitted."
description: "The active consensus version to which the block being submitted belongs."
requestBody:
description: "The `SignedBeaconBlock` object composed of `BeaconBlock` object (produced by beacon node) and validator signature."
required: true
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/blocks/blocks.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: false
name: Eth-Consensus-Version
description: "Version of the block being submitted, if using SSZ encoding."
description: "The active consensus version to which the block being submitted belongs."
requestBody:
description: "The `SignedBeaconBlock` object composed of `BeaconBlock` object (produced by beacon node) and validator signature."
required: true
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/pool/attestations.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: true
name: Eth-Consensus-Version
description: "Version of the attestations being submitted."
description: "The consensus version to which the attestations being submitted belong."
tags:
- Beacon
- ValidatorRequiredApi
Expand Down
2 changes: 1 addition & 1 deletion apis/beacon/pool/attester_slashings.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ post:
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: true
name: Eth-Consensus-Version
description: "Version of the attester slashing being submitted."
description: "The active consensus version to which the attester slashing being submitted belongs."
tags:
- Beacon
requestBody:
Expand Down
2 changes: 1 addition & 1 deletion apis/validator/aggregate_and_proofs.v2.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ post:
$ref: '../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
required: true
name: Eth-Consensus-Version
description: "Version of the aggregate and proofs being submitted."
description: "The active consensus version to which the aggregate and proofs being submitted belong."
requestBody:
required: true
content:
Expand Down
4 changes: 3 additions & 1 deletion beacon-node-oapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -448,7 +448,9 @@ components:

headers:
Eth-Consensus-Version:
description: Required in response so client can deserialize returned json or ssz data more effectively.
description: |
The active consensus version to which the data belongs. Required in response so client can deserialize returned json or ssz data
more effectively.
mehdi-aouadi marked this conversation as resolved.
Show resolved Hide resolved
required: true
schema:
$ref: '#/components/schemas/ConsensusVersion'
Expand Down