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

Update Timeseries API documentation to clarify "unit" query parameter #657

Open
rma-rripken opened this issue May 21, 2024 · 2 comments
Open
Labels
approved-W192HQ23F0232-task4 Only valid if set by MikeNeilson, DanielO, CharlesG timeseries

Comments

@rma-rripken
Copy link
Collaborator

Despite the current documentation "Other" is not an actual valid input for the unit query parameter.

The documentation should be clarified.

The desired behavior was for users to be able to specify a unit system and they would get values in the default unit for the parameter from that system
OR
the user could specify the exact unit they wanted "mm" or "m" and they would get values in the specified unit.

Maybe A new unit-system query parameter that accepts only EN/SI would be a clearer way to accomplish this?

@rma-rripken
Copy link
Collaborator Author

#622

@rma-rripken rma-rripken added good first issue Good for newcomers timeseries needs-approval and removed good first issue Good for newcomers labels May 21, 2024
@MikeNeilson MikeNeilson added approved-W192HQ23F0232-task4 Only valid if set by MikeNeilson, DanielO, CharlesG and removed needs-approval labels May 21, 2024
@MikeNeilson
Copy link
Contributor

Looking at it, I think just removing the text "Other" would be sufficient. But maybe update the string to:

Any measurement unit appropriate to the data requested. Units supported by the system are available at /units ... and then it's probably time to update the units endpoint.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved-W192HQ23F0232-task4 Only valid if set by MikeNeilson, DanielO, CharlesG timeseries
Projects
None yet
Development

No branches or pull requests

2 participants