feat(time series): Add time_series_type helper param to data_modeling.time_series.list (DM-4186) - #2870
feat(time series): Add time_series_type helper param to data_modeling.time_series.list (DM-4186)#2870haakonvt wants to merge 9 commits into
time_series_type helper param to data_modeling.time_series.list (DM-4186)#2870Conversation
There was a problem hiding this comment.
Code Review
This pull request adds support for filtering state time series in the Data Modeling Time Series API by introducing an is_state parameter to the list methods. It also updates the classic Time Series API documentation to clarify that state time series are only accessible via the Data Modeling API. The review feedback suggests improving type safety in the new unit tests by replacing bare dict type hints with explicit dict[str, Any] annotations, in accordance with the repository's Strong Typing style guide.
data_modeling.time_series.listis_state helper param to data_modeling.time_series.list
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #2870 +/- ##
==========================================
- Coverage 93.49% 93.48% -0.01%
==========================================
Files 527 528 +1
Lines 55489 55555 +66
==========================================
+ Hits 51879 51938 +59
- Misses 3610 3617 +7
🚀 New features to boost your workflow:
|
is_state helper param to data_modeling.time_series.listis_state helper param to data_modeling.time_series.list (DM-4186)
df2887f to
4ec523c
Compare
ccde315 to
168b210
Compare
…ling.time_series.list
A single type (or a sequence of one) filters with Equals, several types with In, and an empty sequence raises.
168b210 to
8062bdc
Compare
|
🦄 |
|
Currently blocked by pg3 bug: https://github.com/cognitedata/pgpgpg/pull/2227 |
is_state helper param to data_modeling.time_series.list (DM-4186)time_series_type helper param to data_modeling.time_series.list (DM-4186)
Description
The classic time series API (
client.time_series.list/client.time_series(...)) never returns state time series: the API leaves them out unlessincludeAllTypes=trueis passed (beta), which the SDK does not support. This holds even when filtering ontype="state"(tested + confirmed with the Time Series team on Slack). This PR makes that discoverable and gives users an easy way to list state time series instead.time_series_typeparameter onclient.data_modeling.time_series.list.TimeSeriesAPI.listand__call__explaining that state time series are never returned, with a Sphinx link toclient.data_modeling.time_series.list(is_state=True).