USACE / USACE/cwms-data-api

Add clear TS Store Rule documentation

Open
#492 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

Currently swagger displays the different options in a combobox without much details on what the rules do. Use existing documentation as reference: PL/SQL documentation or Javadocs

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

Compare the linked PL/SQL documentation and TimeSeriesStoreRule Javadocs, then locate the TS Store Rule definition used by Swagger in this repository. Document what each combobox option does so the generated Swagger display provides clear details for every rule.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.