Skip to content

Add ReadTheDocs Links from Swagger Page? #1892

Description

@krowvin

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    discussion-pointSomething to talk about but take no action yetenhancementNew feature or request

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions