Update DeleteWorkflowExecution description (#3048)

temporalio · Jul 14, 2022 · 1b95eaf · 1b95eaf
1 parent 7f16276
commit 1b95eaf
Show file tree

Hide file tree

Showing 2 changed files with 9 additions and 6 deletions.
diff --git a/api/historyservice/v1/service.pb.go b/api/historyservice/v1/service.pb.go
diff --git a/proto/internal/temporal/server/api/historyservice/v1/service.proto b/proto/internal/temporal/server/api/historyservice/v1/service.proto
@@ -139,8 +139,9 @@ service HistoryService {
     rpc TerminateWorkflowExecution (TerminateWorkflowExecutionRequest) returns (TerminateWorkflowExecutionResponse) {
     }
 
-    // DeleteWorkflowExecution deletes a closed workflow execution asynchronously (workflow must be completed or terminated before).
-    // This method is EXPERIMENTAL and may be changed or removed in a later release.
+    // DeleteWorkflowExecution asynchronously deletes a specific Workflow Execution (when WorkflowExecution.run_id is
+    // provided) or the latest Workflow Execution (when WorkflowExecution.run_id is not provided). If the Workflow
+    // Execution is Running, it will be terminated before deletion.
     rpc DeleteWorkflowExecution (DeleteWorkflowExecutionRequest) returns (DeleteWorkflowExecutionResponse) {
     }