docs: document allowQueue parameter for job execution creation - #745
Merged
Merged
Conversation
Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
Contributor
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
Contributor
Author
🤖 Devin AI EngineerI'll be helping with this pull request! Here's what you should know: ✅ I will automatically:
Note: I can only respond to comments from users who have write access to this repository. ⚙️ Control Options:
|
drappier-charles
marked this pull request as ready for review
August 21, 2026 21:13
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
Documents the new
allowQueueparameter on job execution creation (blaxel-ai/controlplane#5229).Jobs/Manage-job-execution-ts.mdxandJobs/Manage-job-execution-py.mdx: new "Reject immediately when capacity is unavailable" section. Omitted ortruekeeps queue-and-retry;allowQueue: false(Pythonallow_queue=False) checks capacity synchronously and returns 429 (temporary shortage) or 400 (never fits quota), with no execution created and nothing queued on rejection.api-reference/controlplane.yml: synced from controlplanemain(same copy the poll-upstream workflow performs) so the Management API reference showsallowQueueonCreateJobExecutionRequest. The sync also picks up the unrelated upstreamSandboxInfrastructureErrorschema added since the last auto-update.Companion SDK PRs: blaxel-ai/sdk-typescript#431, blaxel-ai/sdk-python#226.
Link to Devin session: https://app.devin.ai/sessions/829498efd05742f79300261953889d6d
Requested by: @drappier-charles
Note
Low Risk
Documentation and OpenAPI schema updates only; no runtime or security behavior changes in this repo.
Overview
Documents the new
allowQueue/allow_queueflag on job execution creation so callers can fail fast when workspace capacity is full instead of queueing.Python and TypeScript job-execution guides add a Reject immediately when capacity is unavailable section: default remains queue-and-retry;
falsechecks capacity at create time and returns 429 (temporary) or 400 (never fits quota), with no execution created.The OpenAPI spec adds
allowQueueonCreateJobExecutionRequest. The same spec sync also introduces read-only sandboxerrorsand theSandboxInfrastructureErrorschema.Reviewed by Cursor Bugbot for commit 01e5cdc. Bugbot is set up for automated code reviews on this repo. Configure here.