Update Timeseries API documentation to clarify "unit" query parameter
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
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?
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
No documentation file or test is named. Start by locating the Timeseries API documentation for the unit query parameter and checking its current description against the API behavior. Done means documenting valid inputs and the agreed unit-system or exact-unit behavior after the open design question is settled.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100