USACE / USACE/cwms-data-api

Create Status Endpoint for Districts

Open
#1,032 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

discussion-point priority:low
Dominant language
Java
Stars
28
Forks
25
Avg merge
4d 22h
Merged PRs (30d)
20

Description

Creation of a status endpoint

/offices/<district>/status

That would allow for querying the current Operational Status of a district

For example

Normal

Flood

Low Water

Drought

To name a few

These options would be defined by districts/group and then have a POST method that would allow setting the status (requiring auth)

Districts could then integrate these status into various scripts including IT processes to report a district's given status, or implement a dashboard of sorts for upward reporting of district status as a whole.

This could also be used on the public/internal sites to report status. I.e. in the header

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 reviewing the existing district endpoint patterns and authentication handling. Define how district or group status options are stored, how GET /offices//status reports the current value, and how the authenticated POST changes it. Done means districts can configure statuses, clients can query them, and unauthorized updates are rejected.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, authentication, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.