Measurement timewindow description is incorrect.
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
During the 1/12 documentation meeting I noticed that the begin/end parameter for the Measurement controller getAll() describes begin/end as the timewindow "to delete" instead of "to retrieve".
I suspect this was a copy/paste bug and should be to retrieve instead.
OutletController getOne has a similar error where its "created" instead of "retrieved"
SpecifiedLevelController delete talks about "timeseries identifier" when it should probably be about "specified level id"
TurbineChangesPostController mentions "delete protections" when I think it should be "override protection of"
Virtual Outlet getOne has "to be created" when it should probably be "to be retrieved".
There might be more.
I'd consider simplifying all the "included in the response" with "retrieved" but that isn't a real bug just simplification.
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
Start by searching the Java controller documentation for the quoted phrases and the Measurement, Outlet, SpecifiedLevel, TurbineChangesPost, and Virtual Outlet endpoints. Correct the listed parameter descriptions, review nearby endpoint descriptions for similar wording errors, and confirm that the updated documentation consistently describes retrieval, deletion, creation, and protection overrides.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100