USACE / USACE/cwms-data-api

Measurement timewindow description is incorrect.

Open
#1,533 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
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

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. 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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.