USACE / USACE/cwms-data-api

Basins end-point seems to require office-id

Open
#1,535 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 documentation meeting the Basins end-point was demoed. The office-id parameter description says that if no office is specified that data from all offices will be returned. However if you don't specify office-id it seems that no data is returned but if you specify MVP you get some data back.

The description should be changed to match the behavior or the behavior changed to match the description.

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 with the Basins endpoint and its office-id parameter, then reproduce the request with and without office-id, including office-id=MVP. Compare the observed response with the parameter description and determine whether the documented behavior or endpoint behavior is intended; done means they agree.

Written by the indexing model from the issue text.

Assessment

Domain
api
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 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.