Skip to content

Commit 533bb82

Browse files
committed
docs: correct the combined override body field, reset 400, and gate example
1 parent bed02f9 commit 533bb82

2 files changed

Lines changed: 7 additions & 2 deletions

File tree

docs/queue-concurrency.mdx

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -207,6 +207,9 @@ await processWebhook.trigger(payload, { concurrencyKey: tenantId });
207207
A gate without a `concurrencyKey` uses the run's own key, so the shared `tenant` queue above caps each tenant across every task that names it as a gate. Give the gate a literal key to pin it to a single slot pool instead, for example capping all traffic to one external provider across your whole environment:
208208

209209
```ts /trigger/sync.ts
210+
//the gate's capacity comes from the queue's own declaration
211+
export const providerApiQueue = queue({ name: "provider-api", concurrencyLimit: 5 });
212+
210213
export const syncToProvider = task({
211214
id: "sync-to-provider",
212215
queue: [

docs/v3-openapi.yaml

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3070,7 +3070,7 @@ paths:
30703070
application/json:
30713071
schema:
30723072
type: object
3073-
required: ["combinedConcurrencyLimit"]
3073+
required: ["concurrencyLimit"]
30743074
properties:
30753075
type:
30763076
type: string
@@ -3081,7 +3081,7 @@ paths:
30813081
- `id`: Treat as a queue ID (default)
30823082
- `task`: Treat as a task ID to get the task's default queue
30833083
- `custom`: Treat as a custom queue name
3084-
combinedConcurrencyLimit:
3084+
concurrencyLimit:
30853085
type: integer
30863086
minimum: 0
30873087
maximum: 100000
@@ -3158,6 +3158,8 @@ paths:
31583158
application/json:
31593159
schema:
31603160
"$ref": "#/components/schemas/QueueObject"
3161+
"400":
3162+
description: The queue's combined concurrency limit is not overridden, or invalid request parameters
31613163
"401":
31623164
description: Unauthorized request
31633165
"404":

0 commit comments

Comments
 (0)