Skip to content

Commit ca2f9a8

Browse files
authored
clarify the consensus version headers (#470)
1 parent 6f55437 commit ca2f9a8

9 files changed

+11
-8
lines changed

apis/beacon/blocks/attestations.v2.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ get:
1515
headers:
1616
Eth-Consensus-Version:
1717
$ref: '../../../beacon-node-oapi.yaml#/components/headers/Eth-Consensus-Version'
18+
description: "The active consensus version to which the attestations belong."
1819
content:
1920
application/json:
2021
schema:

apis/beacon/blocks/blinded_blocks.v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ post:
4242
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
4343
required: true
4444
name: Eth-Consensus-Version
45-
description: "Version of the block being submitted."
45+
description: "The active consensus version to which the block being submitted belongs."
4646
requestBody:
4747
description: "The `SignedBlindedBeaconBlock` object composed of `BlindedBeaconBlock` object (produced by beacon node) and validator signature."
4848
required: true

apis/beacon/blocks/blinded_blocks.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ post:
2121
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
2222
required: false
2323
name: Eth-Consensus-Version
24-
description: "Version of the block being submitted, if using SSZ encoding."
24+
description: "The active consensus version to which the block being submitted belongs."
2525
requestBody:
2626
description: "The `SignedBlindedBeaconBlock` object composed of `BlindedBeaconBlock` object (produced by beacon node) and validator signature."
2727
required: true

apis/beacon/blocks/blocks.v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ post:
4141
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
4242
required: true
4343
name: Eth-Consensus-Version
44-
description: "Version of the block being submitted."
44+
description: "The active consensus version to which the block being submitted belongs."
4545
requestBody:
4646
description: "The `SignedBeaconBlock` object composed of `BeaconBlock` object (produced by beacon node) and validator signature."
4747
required: true

apis/beacon/blocks/blocks.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ post:
2020
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
2121
required: false
2222
name: Eth-Consensus-Version
23-
description: "Version of the block being submitted, if using SSZ encoding."
23+
description: "The active consensus version to which the block being submitted belongs."
2424
requestBody:
2525
description: "The `SignedBeaconBlock` object composed of `BeaconBlock` object (produced by beacon node) and validator signature."
2626
required: true

apis/beacon/pool/attestations.v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -67,7 +67,7 @@ post:
6767
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
6868
required: true
6969
name: Eth-Consensus-Version
70-
description: "Version of the attestations being submitted."
70+
description: "The consensus version to which the attestations being submitted belong."
7171
tags:
7272
- Beacon
7373
- ValidatorRequiredApi

apis/beacon/pool/attester_slashings.v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ post:
4242
$ref: '../../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
4343
required: true
4444
name: Eth-Consensus-Version
45-
description: "Version of the attester slashing being submitted."
45+
description: "The active consensus version to which the attester slashing being submitted belongs."
4646
tags:
4747
- Beacon
4848
requestBody:

apis/validator/aggregate_and_proofs.v2.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ post:
1111
$ref: '../../beacon-node-oapi.yaml#/components/schemas/ConsensusVersion'
1212
required: true
1313
name: Eth-Consensus-Version
14-
description: "Version of the aggregate and proofs being submitted."
14+
description: "The active consensus version to which the aggregate and proofs being submitted belong."
1515
requestBody:
1616
required: true
1717
content:

beacon-node-oapi.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -448,7 +448,9 @@ components:
448448

449449
headers:
450450
Eth-Consensus-Version:
451-
description: Required in response so client can deserialize returned json or ssz data more effectively.
451+
description: |
452+
The active consensus version to which the data belongs. Required in response so client can deserialize returned json or ssz data
453+
more effectively.
452454
required: true
453455
schema:
454456
$ref: '#/components/schemas/ConsensusVersion'

0 commit comments

Comments
 (0)