Skip to content

Clarify that version header is only required with SSZ encoding#118

Merged
ralexstokes merged 1 commit into
ethereum:mainfrom
nflaig:clarify-version-header
May 2, 2025
Merged

Clarify that version header is only required with SSZ encoding#118
ralexstokes merged 1 commit into
ethereum:mainfrom
nflaig:clarify-version-header

Conversation

@nflaig
Copy link
Copy Markdown
Member

@nflaig nflaig commented Apr 2, 2025

While the schema already notes that the Eth-Consensus-Version header is not required, we should clarify that it is actually required for requests / responses that are SSZ encoded.

This formalizes it more on the spec itself as #104 mostly just highlighted that in the PR description.

Adds Eth-Consensus-Version to responses, only required if response body is SSZ encoded but preferably should be added to all responses eventually

The current header description also contradicts with the schema as it is inherited from the beacon-api and notes that it is required for all responses which is not correct for the builder-api spec yet.

The active consensus version to which the data belongs. Required in response so client can deserialize returned json or ssz data more effectively.

So we need to override this description on the builder-api spec for now.

Also rephrases the header description slightly to match more recent changes done to beacon-api in ethereum/beacon-APIs#470.

Copy link
Copy Markdown
Member

@ralexstokes ralexstokes left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the clarification!

@ralexstokes ralexstokes merged commit d8f1f17 into ethereum:main May 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants