docs: document org-wide default per-project concurrency cap#405
Conversation
Add a Concurrency Limits section explaining the org-level default, the per-project override, and how a project's effective cap resolves. Also update the projects endpoint table to the canonical /org/projects paths (the bare /projects routes are deprecated). Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
|
Firetiger deploy monitoring skipped This PR didn't match the auto-monitor filter configured on your GitHub connection:
Reason: This PR is documentation-only (edits to To monitor this PR anyway, reply with |
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit bff0c6c. Configure here.
| -H "Authorization: Bearer $KERNEL_API_KEY" \ | ||
| -H "Content-Type: application/json" \ | ||
| -d '{ "default_project_max_concurrent_sessions": 10 }' | ||
| ``` |
There was a problem hiding this comment.
cURL tab in guide CodeGroup
Medium Severity
The Set an org-wide default CodeGroup adds a cURL tab with a raw PATCH request. Guide pages in info/ are meant to show TypeScript, Python, and Go SDK examples only; REST examples belong in API reference, not alongside SDK tabs on this page.
Triggered by learned rule: Guide pages use SDK examples only — no CLI or REST API subsections
Reviewed by Cursor Bugbot for commit bff0c6c. Configure here.
There was a problem hiding this comment.
Risk assessment: Very Low Risk
Evidence from the diff: this PR modifies only info/projects.mdx, adding and correcting user-facing documentation for project concurrency limits and related endpoint examples. There are no changes to production codepaths, generated API specs, navigation/config, infrastructure, auth/permissions logic, or shared libraries. I also found no CODEOWNERS file in the repo requiring owner review for this path.
Approval decision: approved because the change is documentation-only with a small, isolated blast radius and the PR had not already been approved.
Sent by Cursor Automation: Assign PR reviewers
2 participants
Summary
Documents the new org-wide default per-project concurrency cap on the Projects page (
info/projects.mdx):PATCH /org/limitsexample./org/projects/...paths — the bare/projects/...routes are deprecated.The API Reference tab is auto-generated from the Stainless OpenAPI spec, so the
/org/limitsendpoint reference will appear there automatically once the API ships — this PR only covers the hand-written guide prose.Depends on
The API endpoint (
GET/PATCH /org/limits) lands in kernel/kernel#2350. This is a draft and should merge alongside / after that ships.Needs verification before merge
stainless.yamland have not been run against generated SDKs — the SDKs regenerate after kernel/kernel#2350 merges and Stainless syncs. ThecURLexample is authoritative; please verify the SDK method/type names (organization.limits.update,OrganizationLimitUpdateParams,UpdateOrgLimitsRequestParam) against the published SDKs before merging.Test plan
Note
Low Risk
Documentation-only changes to
info/projects.mdxwith no runtime or API behavior in this repo.Overview
Updates the Projects guide to match the canonical org-scoped API and the new org-wide default concurrency cap.
The Managing Projects table now uses
/org/projects/...instead of deprecated/projects/...paths; per-project limit routes are documented under concurrency instead of in that table. The intro Why Projects? bullet now describes org-wide default caps plus per-project overrides.A new Concurrency Limits section explains org vs per-project caps, resolution order (project override → org default → org limit only), endpoint tables for
GET/PATCH /org/limitsand/org/projects/{id}/limits, and multi-language examples for settingdefault_project_max_concurrent_sessions.Reviewed by Cursor Bugbot for commit bff0c6c. Bugbot is set up for automated code reviews on this repo. Configure here.