Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Feature Request] Deprecate list workflow methods? #307

Open
lorensr opened this issue Aug 21, 2023 · 0 comments
Open

[Feature Request] Deprecate list workflow methods? #307

lorensr opened this issue Aug 21, 2023 · 0 comments
Labels
enhancement New feature or request

Comments

@lorensr
Copy link
Contributor

lorensr commented Aug 21, 2023

Is your feature request related to a problem? Please describe.

I heard we might want to deprecate some of these:

// ListOpenWorkflowExecutions is a visibility API to list the open executions in a specific namespace.
//
// (-- api-linter: core::0127::http-annotation=disabled
// aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
rpc ListOpenWorkflowExecutions (ListOpenWorkflowExecutionsRequest) returns (ListOpenWorkflowExecutionsResponse) {
}
// ListClosedWorkflowExecutions is a visibility API to list the closed executions in a specific namespace.
//
// (-- api-linter: core::0127::http-annotation=disabled
// aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
rpc ListClosedWorkflowExecutions (ListClosedWorkflowExecutionsRequest) returns (ListClosedWorkflowExecutionsResponse) {
}
// ListWorkflowExecutions is a visibility API to list workflow executions in a specific namespace.
rpc ListWorkflowExecutions (ListWorkflowExecutionsRequest) returns (ListWorkflowExecutionsResponse) {
option (google.api.http) = {
get: "/api/v1/namespaces/{namespace}/workflows"
};
}
// ListArchivedWorkflowExecutions is a visibility API to list archived workflow executions in a specific namespace.
rpc ListArchivedWorkflowExecutions (ListArchivedWorkflowExecutionsRequest) returns (ListArchivedWorkflowExecutionsResponse) {
option (google.api.http) = {
get: "/api/v1/namespaces/{namespace}/archived-workflows"
};
}
// ScanWorkflowExecutions is a visibility API to list large amount of workflow executions in a specific namespace without order.
//
// (-- api-linter: core::0127::http-annotation=disabled
// aip.dev/not-precedent: HTTP users should use ListWorkflowExecutions instead. --)
rpc ScanWorkflowExecutions (ScanWorkflowExecutionsRequest) returns (ScanWorkflowExecutionsResponse) {
}

Users get surprised by the limitations of ListOpen/ListClosed (example).

Describe the solution you'd like

Mark deprecated these:

  • ListOpenWorkflowExecutions
  • ListClosedWorkflowExecutions

And keep these?

  • ListWorkflowExecutions
  • ListArchivedWorkflowExecutions (assuming you can't get archived workflows from ListWorkflowExecutions?)
  • ScanWorkflowExecutions (if it's important to have an unordered option?)
@lorensr lorensr added the enhancement New feature or request label Aug 21, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant