Skip to content

Add recording and edge filters to get_coverage - #201

Merged
Mo-Elshenawy1 merged 4 commits into
mainfrom
mostafa/api-sync-d3b02d4-coverage
Nov 3, 2026
Merged

Mo-Elshenawy1 merged 4 commits into
mainfrom
mostafa/api-sync-d3b02d4-coverage

Conversation

@Mo-Elshenawy1

Copy link
Copy Markdown
Contributor

Changelog

get_coverage can filter by recording, include Edge Site and Foxlet recordings, and returns each range's import status.

Docs

None

Description

get_coverage gains recording_id, recording_key, and include_edge_recordings, and each result now has import_status (set when edge recordings are included, None otherwise). start and end become optional, since the API only requires them when no recording or session filter is given. Existing calls are unchanged.

Validated with black, flake8, pyright, and the test suite.

BeforeAfter
client.get_coverage(start=start, end=end, device_id="dev_1")
# edge recordings excluded; no import status
client.get_coverage(recording_key="run.mcap", include_edge_recordings=True)
# [{"device_id": ..., "start": ..., "end": ..., "import_status": "pending"}]

Generated by Claude Code

get_coverage accepts recording_id, recording_key, and include_edge_recordings,
returns each range's import_status, and no longer requires start and end, which
the API only needs when no recording or session filter is given.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012yf4xphn6VfthBaKLpn2Xu
foxglove-beefcake[bot]

This comment was marked as outdated.

bool_query_param takes a bool, so passing an Optional[bool] fails type checking.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_012yf4xphn6VfthBaKLpn2Xu

@foxglove-beefcake foxglove-beefcake Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

Risk: moderate. The change adds optional parameters and a response field to the public get_coverage SDK method, and existing calls continue to work.

@foxglove-beefcake foxglove-beefcake Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

LGTM

Risk: moderate. The change adds optional parameters and a response field to the public get_coverage SDK method, and existing calls continue to work.

@Mo-Elshenawy1
Mo-Elshenawy1 merged commit f7ccf20 into main Nov 3, 2026
2 checks passed
@Mo-Elshenawy1
Mo-Elshenawy1 deleted the mostafa/api-sync-d3b02d4-coverage branch November 3, 2026 23:44
@mguida22 mguida22 mentioned this pull request Nov 4, 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.

3 participants