[CDF-21657] Add status filter to workflow executions list #1793
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1793 +/- ##
==========================================
- Coverage 92.93% 92.90% -0.04%
==========================================
Files 121 121
Lines 17691 17696 +5
==========================================
- Hits 16441 16440 -1
- Misses 1250 1256 +6
|
cognite/client/_api/workflows.py
Outdated
| @@ -212,6 +212,7 @@ def list( | |||
| workflow_version_ids: WorkflowVersionIdentifier | MutableSequence[WorkflowVersionIdentifier] | None = None, | |||
| created_time_start: int | None = None, | |||
| created_time_end: int | None = None, | |||
| statuses: list[Literal["completed", "failed", "running", "terminated", "timed_out"]] | None = None, | |||
There was a problem hiding this comment.
Can you also allow a single status to be passed in, not just a list? It is a minor thing, but makes the users life a bit easier
There was a problem hiding this comment.
Any reason why this list is different than? https://github.com/cognitedata/cognite-sdk-python/blob/master/cognite/client/data_classes/workflows.py#L24
There was a problem hiding this comment.
The statuses there are the statuses for Tasks. The naming is a bit unfortunate. Would be a potential breaking change.
+ correctly differentiate between Workflow and Task statuses
| @@ -32,6 +32,8 @@ | |||
| "skipped", | |||
| ] | |||
|
|
|||
| WorkflowStatus: TypeAlias = Literal["completed", "failed", "running", "terminated", "timed_out"] | |||
There was a problem hiding this comment.
"paused" has been removed from the possible statuses.
https://github.com/cognitedata/service-contracts/pull/2535
Description
Allows filtering data workflow executions by status
Checklist:
If a new method has been added it should be referenced in cognite.rst in order to generate docs based on its docstring.