Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve swagger doc usability #347

Open
dblodgett-usgs opened this issue Nov 14, 2022 · 1 comment
Open

Improve swagger doc usability #347

dblodgett-usgs opened this issue Nov 14, 2022 · 1 comment
Assignees

Comments

@dblodgett-usgs
Copy link
Member

As reported by a client developer:

On the page https://labs.waterdata.usgs.gov/api/nldi/swagger-ui/index.html, I can't really find any info that I understand. For example, clicking on the first entry "lookup_controller," it says, "Returns characteristics types." That doesn't give me any insight into what it does or how it is useful.

@dblodgett-usgs dblodgett-usgs self-assigned this Nov 14, 2022
@EthanGrahn
Copy link

There are annotations like this that Swagger provides to generate the docs. I can start creating better documentation to indicate this for future developers. We should also create a list of better descriptions for our current endpoints.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants