Skip to content

Commit 89c73ed

Browse files
authored
docs: document run result and batch API endpoints (#3121)
Adds OpenAPI specs and sidebar pages for four previously undocumented public endpoints: retrieve run result, per-task batch trigger, retrieve batch, and retrieve batch results.
1 parent 97bf898 commit 89c73ed

File tree

6 files changed

+356
-3
lines changed

6 files changed

+356
-3
lines changed

docs/docs.json

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -239,11 +239,11 @@
239239
},
240240
{
241241
"group": "Tasks API",
242-
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger"]
242+
"pages": ["management/tasks/trigger", "management/tasks/batch-trigger", "management/tasks/trigger-batch"]
243243
},
244244
{
245245
"group": "Batches API",
246-
"pages": ["management/batches/create", "management/batches/stream-items"]
246+
"pages": ["management/batches/create", "management/batches/retrieve", "management/batches/retrieve-results", "management/batches/stream-items"]
247247
},
248248
{
249249
"group": "Runs API",
@@ -256,7 +256,8 @@
256256
"management/runs/update-metadata",
257257
"management/runs/add-tags",
258258
"management/runs/retrieve-events",
259-
"management/runs/retrieve-trace"
259+
"management/runs/retrieve-trace",
260+
"management/runs/retrieve-result"
260261
]
261262
},
262263
{
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve batch results"
3+
openapi: "v3-openapi GET /api/v1/batches/{batchId}/results"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve a batch"
3+
openapi: "v3-openapi GET /api/v1/batches/{batchId}"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve run result"
3+
openapi: "v3-openapi GET /api/v1/runs/{runId}/result"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Trigger task batch"
3+
openapi: "v3-openapi POST /api/v1/tasks/{taskIdentifier}/batch"
4+
---

0 commit comments

Comments
 (0)