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

Derive spec types #1

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Derive spec types #1

wants to merge 5 commits into from

Conversation

dapplion
Copy link
Owner

@dapplion dapplion commented Jan 6, 2024

The ethereum/beacon-APIs repo has always required quite a bit of maintenance to produce OpenAPI type definition for the specs types.

This PR produces those types automatically from the ethereum/consensus-specs pyspec files. Selling points:

  • Reduce future maintenance, specially to add new forks
  • Pave the way to SSZ all API routes

A single file types/spec.yaml is produced with https://github.com/dapplion/pyspec2openapi from a config file pyspec2openapi.yml

Diff guide

  • Delete almost all types/**/* files
  • Commit a large auto-generated types/spec.yaml
  • Edit references in apis/* files + beacon-node-oapi.yaml

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
1 participant