Skip to content

Commit c787dce

Browse files
bergundydandavison
andauthored
Clarify run ID may not be current in ResetWorkflowExecutionRequest (#473)
--------- Co-authored-by: Dan Davison <[email protected]>
1 parent 21593a7 commit c787dce

File tree

3 files changed

+11
-2
lines changed

3 files changed

+11
-2
lines changed

openapi/openapiv2.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5504,7 +5504,8 @@
55045504
"type": "string"
55055505
}
55065506
},
5507-
"description": "Identifies a specific workflow within a namespace. Practically speaking, because run_id is a\nuuid, a workflow execution is globally unique. Note that many commands allow specifying an empty\nrun id as a way of saying \"target the latest run of the workflow\"."
5507+
"description": "The workflow to reset. If this contains a run ID then the workflow will be reset back to the\nprovided event ID in that run. Otherwise it will be reset to the provided event ID in the\ncurrent run. In all cases the current run will be terminated and a new run started.",
5508+
"title": "The workflow to reset. If this contains a run ID then the workflow will be reset back to the\nprovided event ID in that run. Otherwise it will be reset to the provided event ID in the\ncurrent run. In all cases the current run will be terminated and a new run started."
55085509
},
55095510
"reason": {
55105511
"type": "string"

openapi/openapiv3.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7498,7 +7498,12 @@ components:
74987498
namespace:
74997499
type: string
75007500
workflowExecution:
7501-
$ref: '#/components/schemas/WorkflowExecution'
7501+
allOf:
7502+
- $ref: '#/components/schemas/WorkflowExecution'
7503+
description: |-
7504+
The workflow to reset. If this contains a run ID then the workflow will be reset back to the
7505+
provided event ID in that run. Otherwise it will be reset to the provided event ID in the
7506+
current run. In all cases the current run will be terminated and a new run started.
75027507
reason:
75037508
type: string
75047509
workflowTaskFinishEventId:

temporal/api/workflowservice/v1/request_response.proto

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -733,6 +733,9 @@ message SignalWithStartWorkflowExecutionResponse {
733733

734734
message ResetWorkflowExecutionRequest {
735735
string namespace = 1;
736+
// The workflow to reset. If this contains a run ID then the workflow will be reset back to the
737+
// provided event ID in that run. Otherwise it will be reset to the provided event ID in the
738+
// current run. In all cases the current run will be terminated and a new run started.
736739
temporal.api.common.v1.WorkflowExecution workflow_execution = 2;
737740
string reason = 3;
738741
// The id of a `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or

0 commit comments

Comments
 (0)