Skip to content

Replace key filter with query syntax and add sorting to property time intervals#155

Open
brookfxg wants to merge 2 commits intomainfrom
brook/fg-14184-update-python-library-with-new-query-syntax
Open

Replace key filter with query syntax and add sorting to property time intervals#155
brookfxg wants to merge 2 commits intomainfrom
brook/fg-14184-update-python-library-with-new-query-syntax

Conversation

@brookfxg
Copy link
Copy Markdown
Contributor

@brookfxg brookfxg commented Mar 31, 2026

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

Screenshot 2026-03-31 at 2 13 03 PM

Another custom test script to simulate use

@linear
Copy link
Copy Markdown

linear bot commented Mar 31, 2026

@brookfxg brookfxg self-assigned this Mar 31, 2026
@brookfxg brookfxg marked this pull request as ready for review March 31, 2026 21:17
@brookfxg brookfxg requested a review from mguida22 as a code owner March 31, 2026 21:17
Copy link
Copy Markdown
Contributor

@claude claude bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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:

  1. 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.

  2. Docs link — the query docstring references https://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? The get_events method 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.

@brookfxg brookfxg changed the title revise query add sort to prop time intervals list Replace key filter with query syntax and add sorting to property time intervals Mar 31, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Development

Successfully merging this pull request may close these issues.

2 participants