Replace key filter with query syntax and add sorting to property time intervals#155
Replace key filter with query syntax and add sorting to property time intervals#155
Conversation
There was a problem hiding this comment.
Clean change — follows established patterns for sort_by/sort_order/query from other list endpoints. comma_separated_query_param removal is safe (no other callers).
Two minor things:
-
PR title — "revise query add sort to prop time intervals list" is a bit telegraphic. Something like "Replace key filter with query syntax and add sorting to property time intervals" would be clearer for the squash-merge commit.
-
Docs link — the
querydocstring referenceshttps://docs.foxglove.dev/api#tag/Devices/paths/~1devices/get(the devices list endpoint). Is query syntax actually documented there for property time intervals, or should this point to the property-time-intervals endpoint specifically? Theget_eventsmethod has the same pattern (pointing to its own endpoint), so this is fine if the syntax definition lives on the devices page — just want to make sure users won't land on an unrelated section.
Changelog
Revise device property history time interval list to use query instead of key, accept sortBy, sortOrder
Docs
None
Description
We had a late revision to the interface for the upcoming device property history time interval. The old interface provided a simple key filter. We've revised that to take the standard query syntax. Also we now support sorting.
Testing
Another custom test script to simulate use