Link to Read the Docs pages in the Swagger Docs UI
@rma-psmorris is already working on this.
Since Aug 25, 2026.
- 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.
When you are in the swagger UI, if possible, can we have this link to the relavent docs.
Describe the solution you'd like
For example, if I expand timeseries, or in the timeseries group header, link to that matching read the docs document.
Describe alternatives you've considered
Add a generic read the docs link at the top.
Additional context
Spoke about this in 08/25/2026
Note about Groundwork possibly overriding the CSS on the swagger UI preventing the underline f
rom displaying. Worth noting that we could override this for the swagger page and make sure links are shown/blue with underline.
The endpoint this was seen on was the "offices" endpoint, the "has-data" comment shows 'Feature #321' but this is a link.
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.
Assessment
This issue has not been assessed yet.