From d1a19798c390d383e0f04e3c6ac10c2b5340538a Mon Sep 17 00:00:00 2001 From: Roey Berman Date: Tue, 12 Nov 2024 14:48:42 -0800 Subject: [PATCH] Incorporate Dan's suggestion --- openapi/openapiv2.json | 4 ++-- openapi/openapiv3.yaml | 6 +++--- temporal/api/workflowservice/v1/request_response.proto | 6 +++--- 3 files changed, 8 insertions(+), 8 deletions(-) diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json index 4720f403..5a963f87 100644 --- a/openapi/openapiv2.json +++ b/openapi/openapiv2.json @@ -5504,8 +5504,8 @@ "type": "string" } }, - "description": "The workflow ID and optional run ID to reset to.\nThe current run will be terminated even if it has a different run ID than the one provided in this\nrequest.", - "title": "The workflow ID and optional run ID to reset to.\nThe current run will be terminated even if it has a different run ID than the one provided in this\nrequest." + "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.", + "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." }, "reason": { "type": "string" diff --git a/openapi/openapiv3.yaml b/openapi/openapiv3.yaml index f0447ef2..e8203f4c 100644 --- a/openapi/openapiv3.yaml +++ b/openapi/openapiv3.yaml @@ -7501,9 +7501,9 @@ components: allOf: - $ref: '#/components/schemas/WorkflowExecution' description: |- - The workflow ID and optional run ID to reset to. - The current run will be terminated even if it has a different run ID than the one provided in this - request. + The workflow to reset. If this contains a run ID then the workflow will be reset back to the + provided event ID in that run. Otherwise it will be reset to the provided event ID in the + current run. In all cases the current run will be terminated and a new run started. reason: type: string workflowTaskFinishEventId: diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto index e3b58ec5..78698c51 100644 --- a/temporal/api/workflowservice/v1/request_response.proto +++ b/temporal/api/workflowservice/v1/request_response.proto @@ -733,9 +733,9 @@ message SignalWithStartWorkflowExecutionResponse { message ResetWorkflowExecutionRequest { string namespace = 1; - // The workflow ID and optional run ID to reset to. - // The current run will be terminated even if it has a different run ID than the one provided in this - // request. + // The workflow to reset. If this contains a run ID then the workflow will be reset back to the + // provided event ID in that run. Otherwise it will be reset to the provided event ID in the + // current run. In all cases the current run will be terminated and a new run started. temporal.api.common.v1.WorkflowExecution workflow_execution = 2; string reason = 3; // The id of a `WORKFLOW_TASK_COMPLETED`,`WORKFLOW_TASK_TIMED_OUT`, `WORKFLOW_TASK_FAILED`, or