Skip to content

Commit 97bf898

Browse files
authored
docs: document undocumented run API endpoints (#3120)
Adds API reference pages for three previously undocumented run endpoints: retrieve run events, retrieve run trace, and add tags to a run.
1 parent b60788d commit 97bf898

File tree

5 files changed

+378
-8
lines changed

5 files changed

+378
-8
lines changed

docs/docs.json

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -253,7 +253,10 @@
253253
"management/runs/replay",
254254
"management/runs/cancel",
255255
"management/runs/reschedule",
256-
"management/runs/update-metadata"
256+
"management/runs/update-metadata",
257+
"management/runs/add-tags",
258+
"management/runs/retrieve-events",
259+
"management/runs/retrieve-trace"
257260
]
258261
},
259262
{

docs/management/runs/add-tags.mdx

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Add tags to a run"
3+
openapi: "v3-openapi POST /api/v1/runs/{runId}/tags"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve run events"
3+
openapi: "v3-openapi GET /api/v1/runs/{runId}/events"
4+
---
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
---
2+
title: "Retrieve run trace"
3+
openapi: "v3-openapi GET /api/v1/runs/{runId}/trace"
4+
---

0 commit comments

Comments
 (0)