Skip to content

Commit 52b79c0

Browse files
committed
more coderabbit changes
1 parent c5d43d8 commit 52b79c0

File tree

2 files changed

+9
-13
lines changed

2 files changed

+9
-13
lines changed
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
---
22
title: "Trigger task batch"
3-
openapi: "v3-openapi POST /api/v1/tasks/{taskId}/batch"
3+
openapi: "v3-openapi POST /api/v1/tasks/{taskIdentifier}/batch"
44
---

docs/v3-openapi.yaml

Lines changed: 8 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1237,10 +1237,10 @@ paths:
12371237
description: The run ID.
12381238
output:
12391239
type: string
1240-
description: The serialized output (present when ok is true).
1240+
description: The serialized output as a string (present when ok is true). Use outputType to determine how to parse it — for "application/json" use JSON.parse().
12411241
outputType:
12421242
type: string
1243-
description: The content type of the output, e.g. "application/json".
1243+
description: The content type of the serialized output, e.g. "application/json".
12441244
error:
12451245
type: object
12461246
description: Error details (present when ok is false).
@@ -2018,14 +2018,9 @@ paths:
20182018
response = requests.post(url, headers=headers, json=data)
20192019
print(response.json())
20202020
2021-
"/api/v1/tasks/{taskId}/batch":
2021+
"/api/v1/tasks/{taskIdentifier}/batch":
20222022
parameters:
2023-
- name: taskId
2024-
in: path
2025-
required: true
2026-
schema:
2027-
type: string
2028-
description: The task identifier.
2023+
- $ref: "#/components/parameters/taskIdentifier"
20292024
post:
20302025
operationId: batch_trigger_task_by_id_v1
20312026
summary: Batch trigger a specific task
@@ -2041,6 +2036,7 @@ paths:
20412036
items:
20422037
type: array
20432038
description: An array of payloads to trigger the task with (max 1,000 items).
2039+
maxItems: 1000
20442040
items:
20452041
$ref: "#/components/schemas/TriggerTaskRequestBody"
20462042
responses:
@@ -2295,7 +2291,7 @@ paths:
22952291
get:
22962292
operationId: get_batch_results_v1
22972293
summary: Retrieve batch results
2298-
description: Returns the execution results of all runs in a batch. Returns 404 if the batch doesn't exist.
2294+
description: Returns the execution results of all completed runs in a batch. Only finished runs (successful or failed) are included in the items array — runs that are still executing are omitted. Returns 404 if the batch doesn't exist.
22992295
responses:
23002296
"200":
23012297
description: Successful request
@@ -2322,10 +2318,10 @@ paths:
23222318
description: The run ID.
23232319
output:
23242320
type: string
2325-
description: The serialized output (present when ok is true).
2321+
description: The serialized output as a string (present when ok is true). Use outputType to determine how to parse it — for "application/json" use JSON.parse().
23262322
outputType:
23272323
type: string
2328-
description: The content type of the output, e.g. "application/json".
2324+
description: The content type of the serialized output, e.g. "application/json".
23292325
error:
23302326
type: object
23312327
description: Error details (present when ok is false).

0 commit comments

Comments
 (0)