USACE / USACE/cwms-data-api

Allow NWW, NWS, and NWP to be used as the "office" string within CDA

Open
#741 5 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

As it stands, in order to interact with NWW data on CDA, the office string "NWDP" needs to be used as the office string. I noticed in the catalog endpoint, if the primary office is set to NWDP, I am able to set the bounding office to NWW and get a list of only the gauges that are utilized by NWW (https://cwms-data.usace.army.mil/cwms-data/catalog/TIMESERIES?office=NWDP&bounding-office-like=NWW).

I was wondering if there would be a way to make it so putting NWW in the office field will directly filter NWW bounding office data from NWDP as both internal and external users might not know to search under NWDP? The example I looked at is that SPA is under the SPD division but you can access SPA data specifically without having to include a “bounding-office-like” field

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 examining the catalog TIMESERIES endpoint behavior for office and bounding-office-like, using the NWW/NWDP example URL and the SPA/SPD comparison in the issue. Determine how NWW, NWS, and NWP should resolve when supplied as office values, then verify that each returns only its corresponding bounding-office data without requiring an additional filter.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, backend-api-design
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.