Skip to content

add project_id to remaining device APIs#133

Merged
gasmith merged 2 commits intomainfrom
gasmith/dc-222-py-add-proj-to-device-apis
Oct 30, 2025
Merged

add project_id to remaining device APIs#133
gasmith merged 2 commits intomainfrom
gasmith/dc-222-py-add-proj-to-device-apis

Conversation

@gasmith
Copy link
Copy Markdown
Contributor

@gasmith gasmith commented Oct 27, 2025

This is one of several changes to relax the device naming constraint to be scoped to a project, instead of an org. This change updates the python client to expose a project_id parameter for various device endpoints.

@gasmith gasmith self-assigned this Oct 27, 2025
@linear
Copy link
Copy Markdown

linear Bot commented Oct 27, 2025

@gasmith gasmith marked this pull request as ready for review October 27, 2025 22:38
@gasmith gasmith requested a review from mguida22 October 27, 2025 22:49
@gasmith gasmith changed the title add projectId to device endpoints add project_id to remaining device APIs Oct 27, 2025
Copy link
Copy Markdown
Member

@mguida22 mguida22 left a comment

Choose a reason for hiding this comment

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

Looks good once the API changes land and the doc comments are updated

Comment thread foxglove/client/api.py Outdated
Comment thread foxglove/client/api.py Outdated
Comment thread foxglove/client/api.py Outdated
Comment thread tests/test_devices.py
Co-authored-by: Mike Guida <guida@foxglove.dev>
Copy link
Copy Markdown
Contributor Author

@gasmith gasmith left a comment

Choose a reason for hiding this comment

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

Thanks for the doc string adjustments; should've caught that myself.

Comment thread foxglove/client/api.py Outdated
Comment thread tests/test_devices.py
@gasmith
Copy link
Copy Markdown
Contributor Author

gasmith commented Oct 30, 2025

Looks good once the API changes land and the doc comments are updated

@mguida22: We should be safe to merge this before the API changes land, right? The API server ignores superfluous query parameters.

@mguida22
Copy link
Copy Markdown
Member

Looks good once the API changes land and the doc comments are updated

@mguida22: We should be safe to merge this before the API changes land, right? The API server ignores superfluous query parameters.

Oh yup, you're right. I was thinking that it would be misleading to accept projectId early before the API uses it, but that's not a problem because the device name constraint is not relaxed yet.

@gasmith gasmith merged commit 865e266 into main Oct 30, 2025
1 check passed
@gasmith gasmith deleted the gasmith/dc-222-py-add-proj-to-device-apis branch October 30, 2025 18:18
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