You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/logs.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -31,6 +31,8 @@ sim logs get <runId> [options]
31
31
32
32
| Option | Required | Description |
33
33
| --- | --- | --- |
34
+
|`--include-workflow-state`| No | Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged. |
35
+
|`--no-include-workflow-state`| No | Send --include-workflow-state as false. |
34
36
|`--trace`| No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
Copy file name to clipboardExpand all lines: apps/docs/content/docs/cli/reference.mdx
+2Lines changed: 2 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2751,6 +2751,8 @@ sim logs get <runId> [options]
2751
2751
2752
2752
| Option | Required | Description |
2753
2753
| --- | --- | --- |
2754
+
|`--include-workflow-state`| No | Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged. |
2755
+
|`--no-include-workflow-state`| No | Send --include-workflow-state as false. |
2754
2756
|`--trace`| No | Show expanded trace spans with inputs, outputs, errors, timing, and cost. |
Copy file name to clipboardExpand all lines: apps/docs/openapi-v2-logs.json
+11-1Lines changed: 11 additions & 1 deletion
Original file line number
Diff line number
Diff line change
@@ -383,6 +383,16 @@
383
383
"pattern": "^[A-Za-z0-9._:-]+$",
384
384
"description": "Unique workflow run identifier."
385
385
}
386
+
},
387
+
{
388
+
"name": "includeWorkflowState",
389
+
"in": "query",
390
+
"required": false,
391
+
"description": "Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged.",
392
+
"schema": {
393
+
"description": "Include the saved workflow snapshot (default: true). Set false to omit block configuration from a log read. Other run fields are unchanged.",
394
+
"type": "boolean"
395
+
}
386
396
}
387
397
],
388
398
"responses": {
@@ -1602,7 +1612,7 @@
1602
1612
"type": "null"
1603
1613
}
1604
1614
],
1605
-
"description": "Workflow graph captured for the run, or null if unavailable. Sensitive values are redacted to null; environment-variable references may be preserved."
1615
+
"description": "Workflow graph captured for the run, or null if unavailable or includeWorkflowState=false. Sensitive values are redacted to null; environment-variable references may be preserved."
'Create and confirm a Stripe payment intent to collect a charge from a customer.',
1098
1125
content:
1099
-
'# Collect Payment\n\nCharge a customer by creating and confirming a payment intent.\n\n## Steps\n1. Run Create Payment Intent with the amount, currency, and customer.\n2. Confirm the intent with Confirm Payment Intent, or Capture Payment Intent if it was created for manual capture.\n3. If a charge needs to be aborted, run Cancel Payment Intent instead.\n\n## Output\nReturn the payment intent ID, its status (succeeded, requires action, or canceled), and the captured amount.',
1126
+
'# Collect Payment\n\nCharge a customer by creating and confirming a payment intent.\n\n## Steps\n1. Run Create Payment Intent with the amount, currency, and customer.\n2. Confirm the intent with Confirm Payment Intent and a payment method. If the confirmed intent has status requires_capture, run Capture Payment Intent to collect the authorized funds.\n3. If a charge needs to be aborted, run Cancel Payment Intent instead.\n\n## Output\nReturn the payment intent ID, its status (succeeded, requires action, or canceled), and the captured amount.',
1100
1127
},
1101
1128
{
1102
1129
name: 'manage-subscription',
1103
-
description: 'Create, update, pause, or cancel a Stripe subscription for a customer.',
1130
+
description:
1131
+
'Create a Stripe subscription, manage its cancellation, or resume a paused subscription.',
1104
1132
content:
1105
-
'# Manage Subscription\n\nHandle the lifecycle of a recurring subscription.\n\n## Steps\n1. To start a subscription, run Create Subscription with the customer and price items.\n2. To change a plan, run Update Subscription with the new items. To pause and later restart, use Cancel Subscription or Resume Subscription as appropriate.\n3. Confirm the current state with Retrieve Subscription.\n\n## Output\nReturn the subscription ID, its status, current period end, and the plan items, and note exactly what changed.',
1133
+
'# Manage Subscription\n\nHandle the lifecycle of a recurring subscription.\n\n## Steps\n1. To start a subscription, run Create Subscription with the customer and price items.\n2. Use Update Subscription with cancel_at_period_end to schedule or reverse a cancellation before it takes effect. Use Cancel Subscription only for immediate cancellation. Resume Subscription applies only to a paused subscription; it does not restart a canceled subscription.\n3. Confirm the current state with Retrieve Subscription.\n\n## Output\nReturn the subscription ID, its status, and the returned subscription items, and note exactly what changed.',
1106
1134
},
1107
1135
{
1108
1136
name: 'issue-invoice',
1109
1137
description: 'Create, finalize, and send a Stripe invoice to a customer, then track payment.',
1110
1138
content:
1111
-
'# Issue Invoice\n\nBill a customer with a Stripe invoice.\n\n## Steps\n1. Run Create Invoice for the customer with the line items.\n2. Run Finalize Invoice to lock it, then Send Invoice to deliver it to the customer.\n3. Track payment with Retrieve Invoice, or run Pay Invoice to charge a saved payment method. Use Void Invoice to cancel an unpaid invoice.\n\n## Output\nReturn the invoice ID, its status (draft, open, paid, or void), the amount due, and the hosted invoice URL when available.',
1139
+
'# Issue Invoice\n\nBill a customer with a Stripe invoice.\n\n## Steps\n1. Run Create Invoice for the customer. This tool does not add line items; add them in Stripe and verify the draft with Retrieve Invoice before finalizing.\n2. Run Finalize Invoice to lock it, then Send Invoice to deliver it to the customer.\n3. Track payment with Retrieve Invoice, or run Pay Invoice to charge a saved payment method. Use Void Invoice to cancel an unpaid invoice.\n\n## Output\nReturn the invoice ID, its status (draft, open, paid, or void), the amount due, and the hosted invoice URL when available.',
* v2 logs contracts. The query schemas are reused verbatim from v1 (the request
28
-
* shape is unchanged); only the response envelope is upgraded to the canonical
29
-
* v2 shapes with concrete item schemas.
26
+
* v2 logs contracts. List queries retain the v1 filters; responses use the
27
+
* canonical v2 envelope and concrete item schemas.
30
28
*/
31
29
32
30
constv2LogCostSchema=z
@@ -164,7 +162,7 @@ const v2LogWorkflowStateSchema = z
164
162
)
165
163
.nullable()
166
164
.describe(
167
-
'Workflow graph captured for the run, or null if unavailable. Sensitive values are redacted to null; environment-variable references may be preserved.'
165
+
'Workflow graph captured for the run, or null if unavailable or includeWorkflowState=false. Sensitive values are redacted to null; environment-variable references may be preserved.'
0 commit comments