How ethereum/beacon-apis works
Project type and purpose
• This is an “open-source tool” repository that defines and publishes the Ethereum Beacon Chain REST API specification.
• It consists of OpenAPI/Swagger YAML files (under apis/ and types/), build-and-bundle scripts, static assets, and CI/CD workflows to produce a browsable documentation site.
File structure
• Top-level directories:
• apis/ – OpenAPI fragment files, organized by endpoint namespaces (beacon, builder, config, etc.).
• types/ – Reusable schema definitions for various protocol versions.
• dist/ – Bundled Swagger-UI assets and generated HTML/CSS/JS for the API browser.
• .github/ – CI/CD workflows: linting, spellcheck, test, build, pre-release, release, deploy.
• params/, README, beacon-node-oapi.yaml – entrypoint for the full API definition and render instructions.
• Key files:
• beacon-node-oapi.yaml – top-level OpenAPI definition that references all apis/ and types/ fragments.
• index.html – landing page for the static API browser.
• .github/workflows/*.yaml – CI pipelines that run redocly lint, bundle, version tagging, and GitHub Pages deployment.
README for additional insights
• The repo produces a REST interface spec for beacon nodes; result is a static site served via any HTTP server.
• Uses Redocly CLI to lint and bundle.
• GitHub Actions automate testing, versioning, and publishing under stable or pre-release tags.