Skip to content

feat(schema): Update schema of engine_getBlobsV2 as per Osaka.md#781

Open
swastik7805 wants to merge 1 commit into
ethereum:mainfrom
swastik7805:engine/schema-update
Open

feat(schema): Update schema of engine_getBlobsV2 as per Osaka.md#781
swastik7805 wants to merge 1 commit into
ethereum:mainfrom
swastik7805:engine/schema-update

Conversation

@swastik7805
Copy link
Copy Markdown
Contributor

@swastik7805 swastik7805 commented Apr 7, 2026

Closes #777

Fix: Align engine_getBlobsV2 result schema with Osaka spec

Problem

The result schema for engine_getBlobsV2 in blob.yaml only declares an array return type. As per osaka.md, the method must return null whenever any requested blob is missing, pruned, or unavailable — making null a primary return value, not an edge case.

The current schema does not permit null, creating a mismatch between the machine-readable spec and the Markdown specification.

Change

Updated the result schema in blob.yaml to use oneOf, allowing eitheran array of BlobAndProofV2 objects or null.

Fix

result:
  name: List of blobs and corresponding cell proofs
  schema:
    oneOf:
      - type: array
        items:
          $ref: '#/components/schemas/BlobAndProofV2'
      - type: 'null'

References

@MysticRyuujin please review the issue and PR

Copy link
Copy Markdown
Contributor

@bomanaps bomanaps left a comment

Choose a reason for hiding this comment

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

LGTM.

@mkalinin
Copy link
Copy Markdown
Contributor

mkalinin commented May 4, 2026

I would also suggest we change the response type definition from Array of BlobAndProofV2 to (Array of BlobAndProofV2) | null in the osaka.md, wdyt?

@bomanaps
Copy link
Copy Markdown
Contributor

bomanaps commented May 4, 2026

I would also suggest we change the response type definition from Array of BlobAndProofV2 to (Array of BlobAndProofV2) | null in the osaka.md, wdyt?

Makes sense to me and while we're touching osaka.md, V3 (line 135) has the exact same problem: the type label says Array of BlobAndProofV2 but the prose describes a null return too, so it'd be worth fixing both V2 and V3 in this PR rather than leaving V3 inconsistent.

cc @swastik7805

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.

Wrong return schema for engine_getBlobsV2

3 participants