-
Notifications
You must be signed in to change notification settings - Fork 78
Open
Labels
enhancementNew feature or requestNew feature or request
Description
Is your feature request related to a problem? Please describe.
I heard we might want to deprecate some of these:
api/temporal/api/workflowservice/v1/service.proto
Lines 356 to 389 in 8f89bdc
| // 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?)
Metadata
Metadata
Assignees
Labels
enhancementNew feature or requestNew feature or request