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.

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

kaywux
Copy link
Member

@kaywux kaywux commented Dec 10, 2024

We have received feedback that users are unsure of what values to pass in for the GetLatestTabularData parameters, and that having an example in the documentation would help.

The plan is to add similar examples to other SDKs once this PR is approved!

@kaywux kaywux requested a review from a team as a code owner December 10, 2024 18:10
@kaywux kaywux changed the title DATA-3565 Add example parameters to documentation DATA-3565 Add example parameters to GetLatestTabularData documentation Dec 12, 2024
Copy link
Member

@njooma njooma left a comment

Choose a reason for hiding this comment

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

Approving based on the assumption that these values have been tested

Copy link
Member

@purplenicole730 purplenicole730 left a comment

Choose a reason for hiding this comment

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

As long as there actually is a method called Readings for sensors. (The method doesn't have to be for sensors, but thought it would be better since the other examples specify a sensor.)

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants