USACE / USACE/cwms-data-api

Should our list based results provide an entry of "error" data sets

Open
#867 10 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

Or perhaps a separate list.

In reviewing #865 it turns out the very first element of the NAB rating templates causes the error, thus zero results are returned.

This would make it rather difficult to fix anything. If the user was aware and had permissions they could correct the element. But all they get in that case is "not valid because X" but which rating template isn't identified at all.

This is possibly true for any other data set, while that shouldn't be able to happen, we do have a lot of historical data from before certain constraints or defaults were appropriately applied.

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 issue #865 and the NAB rating templates, focusing on why the first element causes list-based results to return zero items. Trace how invalid historical data is handled and decide whether errors should be included in the result or returned separately. Done means users can identify the invalid data set or rating template and understand what must be corrected.

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
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.