Skip to content

Commit a09b22e

Browse files
authored
Update description of Visibility Scan API (#638)
_**READ BEFORE MERGING:** All PRs require approval by both Server AND SDK teams before merging! This is why the number of required approvals is "2" and not "1"--two reviewers from the same team is NOT sufficient. If your PR is not approved by someone in BOTH teams, it may be summarily reverted._ <!-- Describe what has changed in this PR --> **What changed?** Update description of Visibility Scan API <!-- Tell your future self why have you made these changes --> **Why?** Visibility Scan API has been marked as deprecated since Temporal v1.27.0. Temporal Server is changing to simply call the `List` API, so updating the description so it is clear. <!-- Are there any breaking changes on binary or code level? --> **Breaking changes** <!-- If this breaks the Server, please provide the Server PR to merge right after this PR was merged. --> **Server PR** temporalio/temporal#8328
1 parent 0286a69 commit a09b22e

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

temporal/api/workflowservice/v1/service.proto

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -458,7 +458,8 @@ service WorkflowService {
458458
};
459459
}
460460

461-
// ScanWorkflowExecutions is a visibility API to list large amount of workflow executions in a specific namespace without order.
461+
// ScanWorkflowExecutions _was_ a visibility API to list large amount of workflow executions in a specific namespace without order.
462+
// It has since been deprecated in favor of `ListWorkflowExecutions` and rewritten to use `ListWorkflowExecutions` internally.
462463
//
463464
// Deprecated: Replaced with `ListWorkflowExecutions`.
464465
// (-- api-linter: core::0127::http-annotation=disabled

0 commit comments

Comments
 (0)