USACE / USACE/cwms-data-api

timeseries/get date and timezone description

Open
#512 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

approved-W192HQ23F0232-task4 documentation timeseries
Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

dates retrieved from timeseries/get endpoint are always UTC. when entering a timezone the date-time values are still UTC even though the description of the field is "Specifies the time zone of the values of the begin and end fields (unless otherwise specified), as well as the time zone of any times in the response."

The description of timezone should be adjusted to specify that this values does not change date-time from the response and values are always in UTC.

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 locating the timezone field description for the timeseries/get endpoint. Update the description so it clearly states that response date-time values remain in UTC even when a timezone is supplied, then verify that the documented behavior matches the endpoint.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.