Open
Conversation
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)
- Merge Sandbox API endpoints into openapi-public.yml with per-path server override
- Add polished/edited version (openapi-public-edited.yml) with comprehensive docs
- Update docs.json to show both API Reference versions side by side
- Remove separate openapi-sandbox.yml (now merged)
- Sandbox endpoints use https://{port}-{sandboxId}.e2b.app server
- Add team metrics endpoints to polished spec
Restore 23 endpoints that were missing from the edited spec: - Sandboxes: v2 create, metrics, resume - Templates: v3/v2 list, v2 get/delete, file hash, builds, status, logs, tags (POST/DELETE), aliases, patch - Filesystem: watchers (create, get events, remove, watch dir) - Process: connect, stream input, update
- Remove curl example workflows from endpoint descriptions - Move /init to first endpoint in Sandboxes section - Move file upload/download endpoints to Sandbox Filesystem section - Remove redundant Sandbox Files tag and SDK-obvious notes
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
https://raw.githubusercontent.com/e2b-dev/infra/main/spec/openapi.yml)/docs/api-reference/...