Skip to content

Add REST API reference from OpenAPI spec#98

Open
beran-t wants to merge 6 commits intomainfrom
swagger-api-docs
Open

Add REST API reference from OpenAPI spec#98
beran-t wants to merge 6 commits intomainfrom
swagger-api-docs

Conversation

@beran-t
Copy link
Contributor

@beran-t beran-t commented Feb 3, 2026

Summary

  • Adds a new "REST API" anchor in the documentation navigation
  • Uses Mintlify's native OpenAPI integration to auto-generate API reference pages
  • Sources the OpenAPI spec directly from the infra repo (https://raw.githubusercontent.com/e2b-dev/infra/main/spec/openapi.yml)
  • Pages are generated at /docs/api-reference/...

Adds a new "REST API" navigation anchor that uses Mintlify's native
OpenAPI support to auto-generate interactive API documentation from
the E2B infra repository's OpenAPI spec.
- Add Sandbox API OpenAPI spec with filesystem and process endpoints
- Filter REST API spec to only include user-facing endpoints (ApiKeyAuth)
- Remove admin/internal endpoints (Supabase-only, AccessToken-only)
- Add sync script to fetch and transform specs from infra repo
- Add GitHub Actions workflow for scheduled sync every 6 hours
- Fix OpenAPI 3.0 compatibility issues in generated specs
- Remove GitHub Actions workflow (sync will be done manually)
- Exclude /init and /metrics from Sandbox API (internal SDK endpoints)
Include proto-generated endpoints:
- filesystem.Filesystem: ListDir, MakeDir, Move, Remove, Stat, watchers
- process.Process: Start, List, Connect, SendInput, SendSignal, Update
- Rename tags: filesystem.Filesystem -> Filesystem, process.Process -> Process
- Add descriptions to tag sections
- Exclude /health endpoint (internal)
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.

1 participant