Add ReadTheDocs Links from Swagger Page?
Nobody has claimed this yet.
- 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.
Users might not know the read the docs pages exist while looking at the swagger page
Describe the solution you'd like
On the main header section of each endpoint in swagger, or within the endpoints, could we add a link to the read the doc pages as they are being made?
https://cwms-data-api.readthedocs.io/latest/endpoints/timeSeries_endpoints/index.html
Room for suggestions on how best to do that
Could you agree: tie name of endpoints to the doc url
Additional context
Brief discussion in the CDA weekly 08/24/26 call
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 at the Swagger page and trace how its endpoint headers or sections are generated, then compare the endpoint names with the ReadTheDocs timeSeries endpoints page. Done means the relevant Swagger endpoints expose links to their corresponding ReadTheDocs pages without breaking the existing API documentation.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- java, openapi
- Domain
- api, documentation
- Issue type
- Feature
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Active
- Clarity
- Mostly clear
- Newbie friendliness
- 55/100