Skip to content

Commit 00830c0

Browse files
authored
Fix Workflow instance id and name (#25445)
1 parent 668c826 commit 00830c0

File tree

2 files changed

+4
-3
lines changed

2 files changed

+4
-3
lines changed

src/content/docs/workflows/build/workers-api.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Refer to the [events and parameters](/workflows/build/events-and-parameters/) do
7979
- <code>step.do(name: string, callback: (): RpcSerializable): Promise&lt;T&gt;</code>
8080
- <code>step.do(name: string, config?: WorkflowStepConfig, callback: ():
8181
RpcSerializable): Promise&lt;T&gt;</code>
82-
- `name` - the name of the step.
82+
- `name` - the name of the step, up to 256 characters.
8383
- `config` (optional) - an optional `WorkflowStepConfig` for configuring [step specific retry behaviour](/workflows/build/sleeping-and-retrying/).
8484
- `callback` - an asynchronous function that optionally returns serializable state for the Workflow to persist.
8585

@@ -250,7 +250,7 @@ Create (trigger) a new instance of the given Workflow.
250250
- <code>create(options?: WorkflowInstanceCreateOptions): Promise&lt;WorkflowInstance&gt;</code>
251251
- `options` - optional properties to pass when creating an instance, including a user-provided ID and payload parameters.
252252

253-
An ID is automatically generated, but a user-provided ID can be specified (up to 64 characters [^1]). This can be useful when mapping Workflows to users, merchants or other identifiers in your system. You can also provide a JSON object as the `params` property, allowing you to pass data for the Workflow instance to act on as its [`WorkflowEvent`](/workflows/build/events-and-parameters/).
253+
An ID is automatically generated, but a user-provided ID can be specified (up to 100 characters [^1]). This can be useful when mapping Workflows to users, merchants or other identifiers in your system. You can also provide a JSON object as the `params` property, allowing you to pass data for the Workflow instance to act on as its [`WorkflowEvent`](/workflows/build/events-and-parameters/).
254254

255255
```ts
256256
// Create a new Workflow instance with your own ID and pass params to the Workflow instance

src/content/docs/workflows/reference/limits.mdx

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ Many limits are inherited from those applied to Workers scripts and as documente
2828
| Maximum Workflow instance creation rate | 100 per 10 seconds [^6] | 100 per 10 seconds [^6] |
2929
| Maximum number of [queued instances](/workflows/observability/metrics-analytics/#event-types) | 10,000 | 100,000 |
3030
| Retention limit for completed Workflow state | 3 days | 30 days [^2] |
31-
| Maximum length of a Workflow ID [^4] | 64 characters | 64 characters |
31+
| Maximum length of a Workflow name [^4] | 64 characters | 64 characters |
32+
| Maximum length of a Workflow instance ID [^4] | 100 characters | 100 characters |
3233
| Maximum number of subrequests per Workflow instance | 50/request | 1000/request |
3334

3435
[^2]: Workflow state and logs will be retained for 3 days on the Workers Free plan and for 7 days on the Workers Paid plan.

0 commit comments

Comments
 (0)