docs: clarify sandbox queueing and create() return semantics#381
Open
mintlify[bot] wants to merge 1 commit into
Open
docs: clarify sandbox queueing and create() return semantics#381mintlify[bot] wants to merge 1 commit into
mintlify[bot] wants to merge 1 commit into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
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
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
Document the new behavior shipped in the upstream
feat: queue sandbox launcheschange: sandbox create is now non-blocking and capacity misses keep the sandbox in thequeuedphase instead of rejecting the request.Changes
sandboxes/overview.mdx: added a Queueing and capacity section explaining that create returns once the request is durable, that queued sandboxes are launched in creation order as capacity frees up, and that callers should poll untilrunningbefore callingexec.sandbox/sdk/python/reference.mdx: noted thatporter.sandboxes.create(...)returns while the sandbox may still bequeuedorcreating, and torefresh()untilphase == "running"before exec.sandbox/sdk/typescript/reference.mdx: same clarification for the TypeScript SDK.Context
Upstream PR makes sandbox create record requests as queued and return once the registry write succeeds, so capacity misses no longer reject accepted runs. A 3s reconciler launches queued records in creation order, and the warm pool sizes itself against current queue depth. Docs previously described
queuedas a phase but did not tell users that create returns before the sandbox is running — these edits close that gap.cc @jackowfish for review.