USACE / USACE/cwms-data-api

Require Public Name for Locations

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

Nobody has claimed this yet.

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

Description

Is your feature request related to a problem? Please describe.
CWMS standard naming recommends that the public name should also be required for locations

Describe the solution you'd like
Require public name field for Location objects.

Describe alternatives you've considered
Turning the public name into a required field is backwards-incompatible. The field could be filled by the location name in cases where the public name is null in order to retain compatibility, but that is behavioral change that would need discussion.

Additional context
Turning the public name into a required field is backwards-incompatible.

Initially discussed on #1563

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 Location object and tracing how its public name is validated or persisted. Review the discussion referenced in #1563 to resolve whether missing values should be rejected or populated from the location name, then define tests covering the chosen behavior and backward-compatibility outcome.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.