Skip to content

Commit add5b50

Browse files
authored
Deprecate ScanWorkflowExecutions (#552)
Deprecate ScanWorkflowExecutions
1 parent 475af1c commit add5b50

File tree

3 files changed

+5
-1
lines changed

3 files changed

+5
-1
lines changed

Diff for: openapi/openapiv2.json

+2-1
Original file line numberDiff line numberDiff line change
@@ -12060,7 +12060,8 @@
1206012060
"type": "string",
1206112061
"format": "byte"
1206212062
}
12063-
}
12063+
},
12064+
"description": "Deprecated: Use with `ListWorkflowExecutions`."
1206412065
},
1206512066
"v1Schedule": {
1206612067
"type": "object",

Diff for: temporal/api/workflowservice/v1/request_response.proto

+2
Original file line numberDiff line numberDiff line change
@@ -899,13 +899,15 @@ message ListArchivedWorkflowExecutionsResponse {
899899
bytes next_page_token = 2;
900900
}
901901

902+
// Deprecated: Use with `ListWorkflowExecutions`.
902903
message ScanWorkflowExecutionsRequest {
903904
string namespace = 1;
904905
int32 page_size = 2;
905906
bytes next_page_token = 3;
906907
string query = 4;
907908
}
908909

910+
// Deprecated: Use with `ListWorkflowExecutions`.
909911
message ScanWorkflowExecutionsResponse {
910912
repeated temporal.api.workflow.v1.WorkflowExecutionInfo executions = 1;
911913
bytes next_page_token = 2;

Diff for: temporal/api/workflowservice/v1/service.proto

+1
Original file line numberDiff line numberDiff line change
@@ -482,6 +482,7 @@ service WorkflowService {
482482

483483
// ScanWorkflowExecutions is a visibility API to list large amount of workflow executions in a specific namespace without order.
484484
//
485+
// Deprecated: Replaced with `ListWorkflowExecutions`.
485486
// (-- api-linter: core::0127::http-annotation=disabled
486487
// aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
487488
rpc ScanWorkflowExecutions (ScanWorkflowExecutionsRequest) returns (ScanWorkflowExecutionsResponse) {

0 commit comments

Comments
 (0)