Create ReadTheDocs documentation for Ratings
Nobody has claimed this yet.
- Dominant language
- Java
- Stars
- 28
- Forks
- 25
- Avg merge
- 4d 22h
- Merged PRs (30d)
- 20
Description
Similar to the ticket for creating TimeSeries documentation ( https://github.com/USACE/cwms-data-api/issues/1117 ) we should create documentation for the Ratings end-points.
The Ratings end-points are significantly complex - there are a variety of end-points and some can take multiple parameters and others require user post data (vs putting everything in query parameters). It would be useful to have examples of how to interact with the end-points (with examples of the json/xml bodies).
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reading the related TimeSeries documentation issue (#1117) and locating the ReadTheDocs material for the Ratings endpoints. Document the endpoint variations, query parameters, POST data requirements, and JSON/XML examples; done means users can understand how to interact with the Ratings endpoints.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Quiet
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100