Deprecate ScanWorkflowExecutions (#552)

Deprecate ScanWorkflowExecutions
temporalio · Feb 7, 2025 · add5b50 · add5b50
1 parent 475af1c
commit add5b50
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/openapi/openapiv2.json b/openapi/openapiv2.json
@@ -12060,7 +12060,8 @@
           "type": "string",
           "format": "byte"
         }
-      }
+      },
+      "description": "Deprecated: Use with `ListWorkflowExecutions`."
     },
     "v1Schedule": {
       "type": "object",

diff --git a/temporal/api/workflowservice/v1/request_response.proto b/temporal/api/workflowservice/v1/request_response.proto
@@ -899,13 +899,15 @@ message ListArchivedWorkflowExecutionsResponse {
     bytes next_page_token = 2;
 }
 
+// Deprecated: Use with `ListWorkflowExecutions`.
 message ScanWorkflowExecutionsRequest {
     string namespace = 1;
     int32 page_size = 2;
     bytes next_page_token = 3;
     string query = 4;
 }
 
+// Deprecated: Use with `ListWorkflowExecutions`.
 message ScanWorkflowExecutionsResponse {
     repeated temporal.api.workflow.v1.WorkflowExecutionInfo executions = 1;
     bytes next_page_token = 2;

diff --git a/temporal/api/workflowservice/v1/service.proto b/temporal/api/workflowservice/v1/service.proto
@@ -482,6 +482,7 @@ service WorkflowService {
 
     // ScanWorkflowExecutions is a visibility API to list large amount of workflow executions in a specific namespace without order.
     //
+    // Deprecated: Replaced with `ListWorkflowExecutions`.
     // (-- api-linter: core::0127::http-annotation=disabled
     //     aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
     rpc ScanWorkflowExecutions (ScanWorkflowExecutionsRequest) returns (ScanWorkflowExecutionsResponse) {