Skip to content

Commit 079b6a6

Browse files
committed
fix(docs): use real ID formats in OpenAPI examples
Workflow, workspace, folder, knowledge-base, document, and execution IDs are plain UUIDv4; workspace file IDs are wf_<shortId>; table and row IDs are tbl_/row_ + de-dashed UUID. Replaces all fake prefixed example IDs (wf_abc123, ws_xyz789, exec_..., kb_..., etc.) accordingly and marks the deploy body description as nullable to match the shared schema.
1 parent 94870e2 commit 079b6a6

2 files changed

Lines changed: 109 additions & 99 deletions

File tree

apps/docs/content/docs/en/workflows/deployment/api.mdx

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -248,8 +248,8 @@ Workflow execution responses are capped by platform request and response limits.
248248
"id": "lv_abc123DEF456",
249249
"kind": "array",
250250
"size": 12582912,
251-
"key": "execution/workspace-id/workflow-id/exec_xyz/large-value-lv_abc123DEF456.json",
252-
"executionId": "exec_xyz",
251+
"key": "execution/workspace-id/workflow-id/c7a92e15-3f4b-4d8c-a1e6-9b0d5f2c8e74/large-value-lv_abc123DEF456.json",
252+
"executionId": "c7a92e15-3f4b-4d8c-a1e6-9b0d5f2c8e74",
253253
"preview": { "length": 25000 }
254254
}
255255
```
@@ -276,7 +276,7 @@ curl -X POST https://sim.ai/api/workflows/{workflow-id}/execute \
276276
"success": true,
277277
"async": true,
278278
"jobId": "run_abc123",
279-
"executionId": "exec_xyz",
279+
"executionId": "c7a92e15-3f4b-4d8c-a1e6-9b0d5f2c8e74",
280280
"message": "Workflow execution queued",
281281
"statusUrl": "https://sim.ai/api/jobs/run_abc123"
282282
}

0 commit comments

Comments
 (0)