docs: exclude internal-only envd endpoints (fixes mintlify dev ENAMETOOLONG) - #334
Merged
Conversation
Six envd/orchestrator internals (/freeze, /unfreeze, /collapse, /fsfreeze, /fsthaw, /files/compose) leak in from the upstream envd spec. The SDKs never call them - they are internals of the pause/resume path. Their multi-sentence summaries also exceed the macOS 255-byte filename limit Mintlify derives from 'summary' (notably /fsfreeze), which aborts the whole API-reference build. Add them to excluded_exact in filter_paths() so a re-add upstream cannot re-leak them, and drop the six path blocks plus the now-orphaned CollapseResult and ComposeRequest schemas from openapi-public.yml (both must change together or the weekly regen re-adds them).
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
jakubno
approved these changes
Aug 6, 2026
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
2 participants
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.
Problem
mintlify devcrashes on macOS before serving anything:Mintlify generates one API-reference page per OpenAPI operation and derives the filename from the operation
summary. Six internal-only envd endpoints leaked into the generatedopenapi-public.ymlwhosesummaryfields are multi-sentence engineering notes./fsfreeze's summary produces a filename over the 255-byte macOS limit, aborting the whole build.Why these endpoints should not be here anyway
The generator's own docstring states the envd spec comes from the curated public copy in
e2b-dev/E2B, which is supposed to exclude internal-only endpoints like/freeze,/collapse,/files/compose. The SDKs never call them. They slipped through becausefilter_paths()'sexcluded_exactonly listed/init, and their auth scheme is not one of the internal markers, so the admin-auth filter did not drop them.Fix
scripts/generate_openapi_reference.py: add the six internal envd paths (/freeze,/unfreeze,/collapse,/fsfreeze,/fsthaw,/files/compose) toexcluded_exactinfilter_paths(), with a comment explaining why.openapi-public.yml: remove those six path blocks and the two now-orphaned schemas (CollapseResult,ComposeRequest). Verified: 61 -> 55 paths, no broken $refs, YAML anchors intact, no unrelated upstream churn.Both change together on purpose:
openapi-public.ymlis regenerated weekly by.github/workflows/api-reference-validation.yml, so without the generator patch the weekly run would re-add the leaked paths.Notes
mainand additionally drops the two orphaned schemas docs: exclude internal-only envd endpoints (fixes mintlify dev ENAMETOOLONG) #331 left behind.Follow-up (not in this PR)
The upstream curated envd spec in
e2b-dev/E2Bstill carries these internal endpoints. Worth fixing there too so this exclusion is defense-in-depth rather than the only guard.