Skip to content

Commit b9e6b1b

Browse files
authored
Update doc on SignalWithStart to support WorkflowIDReusePolicy (#657)
1 parent 6abb244 commit b9e6b1b

File tree

2 files changed

+6
-4
lines changed

2 files changed

+6
-4
lines changed

client/client.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -107,8 +107,9 @@ type (
107107
// SignalWithStartWorkflow sends a signal to a running workflow.
108108
// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
109109
// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
110-
// - workflow, workflowArgs are same as StartWorkflow's parameters
111-
// - options.WorkflowIDReusePolicy will be ignored, and WorkflowIDReusePolicyAllowDuplicate will be used as the policy
110+
// - options, workflow, workflowArgs are same as StartWorkflow's parameters
111+
// Note: options.WorkflowIDReusePolicy is default to WorkflowIDReusePolicyAllowDuplicate in this API;
112+
// while in StartWorkflow/ExecuteWorkflow APIs it is default to WorkflowIdReusePolicyAllowDuplicateFailedOnly.
112113
// The errors it can return:
113114
// - EntityNotExistsError, if domain does not exist
114115
// - BadRequestError

internal/client.go

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -98,8 +98,9 @@ type (
9898
// SignalWithStartWorkflow sends a signal to a running workflow.
9999
// If the workflow is not running or not found, it starts the workflow and then sends the signal in transaction.
100100
// - workflowID, signalName, signalArg are same as SignalWorkflow's parameters
101-
// - workflow, workflowArgs are same as StartWorkflow's parameters
102-
// - options.WorkflowIDReusePolicy will be ignored, and WorkflowIDReusePolicyAllowDuplicate will be used as the policy
101+
// - options, workflow, workflowArgs are same as StartWorkflow's parameters
102+
// Note: options.WorkflowIDReusePolicy is default to WorkflowIDReusePolicyAllowDuplicate in this API;
103+
// while in StartWorkflow/ExecuteWorkflow APIs it is default to WorkflowIdReusePolicyAllowDuplicateFailedOnly.
103104
// The errors it can return:
104105
// - EntityNotExistsError, if domain does not exist
105106
// - BadRequestError

0 commit comments

Comments
 (0)