Skip to content

docs: document allowQueue parameter for job execution creation - #745

Merged
drappier-charles merged 1 commit into
mainfrom
cdrappier/devin/allow-queue-job-execution
Aug 21, 2026
Merged

docs: document allowQueue parameter for job execution creation#745
drappier-charles merged 1 commit into
mainfrom
cdrappier/devin/allow-queue-job-execution

Conversation

@devin-ai-integration

@devin-ai-integration devin-ai-integration Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Summary

Documents the new allowQueue parameter on job execution creation (blaxel-ai/controlplane#5229).

  • Jobs/Manage-job-execution-ts.mdx and Jobs/Manage-job-execution-py.mdx: new "Reject immediately when capacity is unavailable" section. Omitted or true keeps queue-and-retry; allowQueue: false (Python allow_queue=False) checks capacity synchronously and returns 429 (temporary shortage) or 400 (never fits quota), with no execution created and nothing queued on rejection.
POST .../jobs/my-job/executions
{"tasks":[{}],"allowQueue":false}
  • api-reference/controlplane.yml: synced from controlplane main (same copy the poll-upstream workflow performs) so the Management API reference shows allowQueue on CreateJobExecutionRequest. The sync also picks up the unrelated upstream SandboxInfrastructureError schema 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_queue flag 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; false checks capacity at create time and returns 429 (temporary) or 400 (never fits quota), with no execution created.

The OpenAPI spec adds allowQueue on CreateJobExecutionRequest. The same spec sync also introduces read-only sandbox errors and the SandboxInfrastructureError schema.

Reviewed by Cursor Bugbot for commit 01e5cdc. Bugbot is set up for automated code reviews on this repo. Configure here.

Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
@mintlify

mintlify Bot commented Aug 21, 2026

Copy link
Copy Markdown
Contributor

Preview deployment for your docs. Learn more about Mintlify Previews.

Project Status Preview Updated (UTC)
blaxel 🟢 Ready View Preview Aug 21, 2026, 8:30 PM

@devin-ai-integration

Copy link
Copy Markdown
Contributor Author

🤖 Devin AI Engineer

I'll be helping with this pull request! Here's what you should know:

✅ I will automatically:

  • Address comments on this PR that start with 'DevinAI' or '@devin'.
  • Look at CI failures and help fix them

Note: I can only respond to comments from users who have write access to this repository.

⚙️ Control Options:

  • Disable automatic comment, CI, and merge conflict monitoring

@drappier-charles
drappier-charles marked this pull request as ready for review August 21, 2026 21:13
@drappier-charles
drappier-charles merged commit 48903bf into main Aug 21, 2026
6 of 7 checks passed

@devin-ai-integration devin-ai-integration Bot left a comment

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

✅ Devin Review: No Issues Found

Devin Review analyzed this PR and found no bugs or issues to report.

Open in Devin Review

@cploujoux
cploujoux deleted the cdrappier/devin/allow-queue-job-execution branch August 28, 2026 18:49
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