Skip to content

Commit 615fc62

Browse files
committed
docs(api): say the outline's derived fields come from values state already returns
1 parent 6d3908f commit 615fc62

3 files changed

Lines changed: 3 additions & 3 deletions

File tree

‎apps/docs/openapi-v2-workflows.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -599,7 +599,7 @@
599599
"get": {
600600
"operationId": "getWorkflowOutline",
601601
"summary": "Get workflow outline",
602-
"description": "Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and shows nothing Get workflow state does not. The outline is read-only: it adds derived fields such as `triggerWebhookUrl` and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.\n\nOAuth scope: `api:read`.",
602+
"description": "Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and reveals nothing Get workflow state does not: its derived fields, such as `triggerWebhookUrl`, are computed from values that state already returns. The outline is read-only: it adds those derived fields and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.\n\nOAuth scope: `api:read`.",
603603
"x-sim-operation": "workflows.read",
604604
"x-oauth-scope": "api:read",
605605
"tags": ["Workflows"],

‎apps/sim/lib/api/contracts/v2/openapi/workflows.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -357,7 +357,7 @@ const declaredRoutes = [
357357
operationId: 'getWorkflowOutline',
358358
summary: 'Get workflow outline',
359359
description:
360-
'Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and shows nothing Get workflow state does not. The outline is read-only: it adds derived fields such as `triggerWebhookUrl` and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.',
360+
'Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and reveals nothing Get workflow state does not: its derived fields, such as `triggerWebhookUrl`, are computed from values that state already returns. The outline is read-only: it adds those derived fields and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.',
361361
errors: RESOURCE_ERRORS,
362362
success: jsonSuccess('The workflow draft outline.'),
363363
}),

‎apps/sim/lib/api/mcp/generated/v2-operations.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1667,7 +1667,7 @@ export const V2_MCP_OPERATIONS = {
16671667
contract: v2GetWorkflowOutlineContract,
16681668
summary: 'Get workflow outline',
16691669
description:
1670-
'Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and shows nothing Get workflow state does not. The outline is read-only: it adds derived fields such as `triggerWebhookUrl` and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.\n\nOAuth scope: `api:read`.',
1670+
'Read the saved draft as a compact outline: connections embedded in their source blocks, loop and parallel children nested under their container, and empty values and editor-only fields omitted. Requires workspace read access, and reveals nothing Get workflow state does not: its derived fields, such as `triggerWebhookUrl`, are computed from values that state already returns. The outline is read-only: it adds those derived fields and omits positions and edge handles, so never send it to Replace workflow state; edit with Apply workflow operations or a full state from Get workflow state. This read records no audit event; `HEAD` mirrors `GET`.\n\nOAuth scope: `api:read`.',
16711671
handler: () =>
16721672
import('@/app/api/v2/workflows/[workflowId]/outline/route').then((route) => route.GET),
16731673
},

0 commit comments

Comments
 (0)