clarify the consensus version headers (#470)

ethereum · Sep 12, 2024 · ca2f9a8 · ca2f9a8
1 parent 6f55437
commit ca2f9a8
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 8 deletions.
diff --git a/apis/beacon/blocks/attestations.v2.yaml b/apis/beacon/blocks/attestations.v2.yaml
@@ -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:

diff --git a/apis/beacon/blocks/blinded_blocks.v2.yaml b/apis/beacon/blocks/blinded_blocks.v2.yaml
@@ -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

diff --git a/apis/beacon/blocks/blinded_blocks.yaml b/apis/beacon/blocks/blinded_blocks.yaml
@@ -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

diff --git a/apis/beacon/blocks/blocks.v2.yaml b/apis/beacon/blocks/blocks.v2.yaml
@@ -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

diff --git a/apis/beacon/blocks/blocks.yaml b/apis/beacon/blocks/blocks.yaml
@@ -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

diff --git a/apis/beacon/pool/attestations.v2.yaml b/apis/beacon/pool/attestations.v2.yaml
@@ -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

diff --git a/apis/beacon/pool/attester_slashings.v2.yaml b/apis/beacon/pool/attester_slashings.v2.yaml
@@ -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:

diff --git a/apis/validator/aggregate_and_proofs.v2.yaml b/apis/validator/aggregate_and_proofs.v2.yaml
@@ -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:

diff --git a/beacon-node-oapi.yaml b/beacon-node-oapi.yaml
@@ -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.
       required: true
       schema:
         $ref: '#/components/schemas/ConsensusVersion'