Timeseries Groups Patch/Post Swagger Example Request Body Has Incorrect json Identifiers
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
This is not a huge deal, but now that I am doing testing on cwbi-dev, this keeps tripping me up and then I remember I have to change it.
Describe the bug
Swagger example request body has incorrect json identifiers officeId, timeseriesId, aliasId and refTsId under assigned-time-series.
"assigned-time-series": [
{
"officeId": "string",
"timeseriesId": "string",
"aliasId": "string",
"refTsId": "string",
"attribute": 0
}
]
This causes 500 errors if not changed as below.
Expected behavior
These should be hyphenated (like the identifiers in the rest of the example).
"assigned-time-series": [
{
"office-id": "string",
"timeseries-id": "string",
"alias-id": "string",
"ref-ts-id": "string",
"attribute": 0
}
]
To Reproduce
Steps to reproduce the behavior:
- Go to https://water.dev.cwbi.us/cwms-data/swagger-ui
- Scroll to Timeseries Groups
- Click Patch (or Post)
- Click Try it out
- See Request Body
CDA Version (please complete the following information):
- Versions 2025.09.02, 2026.02.11-develop
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 at the Timeseries Groups Swagger UI entry for the Patch and Post request bodies at the referenced endpoint, then locate the corresponding OpenAPI definition. Update the four assigned-time-series identifiers to their hyphenated forms and verify the generated request body no longer uses the incorrect JSON names.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, documentation
- Issue type
- Bug
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100