Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DATA-3565 Add example parameters to GetLatestTabularData documentation #799

Merged
merged 1 commit into from
Dec 17, 2024
Merged

DATA-3565 Add example parameters to GetLatestTabularData documentation #799

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions src/viam/app/data_client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -317,9 +317,9 @@ async def get_latest_tabular_data(

Args:
part_id (str): The ID of the part that owns the data.
resource_name (str): The name of the requested resource that captured the data.
resource_subtype (str): The subtype of the requested resource that captured the data.
method_name (str): The data capture method name.
resource_name (str): The name of the requested resource that captured the data. Ex: "my-sensor".
resource_subtype (str): The subtype of the requested resource that captured the data. Ex: "rdk:component:sensor".
method_name (str): The data capture method name. Ex: "Readings".
Copy link
Member

Choose a reason for hiding this comment

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

Is there a data capture method called Readings? I'm not familiar with this method.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Yes there is! I chose to include this as the example since this is the <component type, capture method> pair that has the most use for this endpoint in prod

Screenshot 2024-12-17 at 3 02 14 PM Screenshot 2024-12-17 at 3 03 28 PM


Returns:
Optional[Tuple[datetime, datetime, Dict[str, ValueTypes]]]: A return value of None means that data hasn't been synced yet for the data source
Expand Down
Loading