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

I am confused by the API doc - where can I find a simple query example? #74

Open
ManonGros opened this issue Jan 24, 2024 · 1 comment
Labels
API Reference Issues relating to enhancing the 'API Reference' section of the technical documentation

Comments

@ManonGros
Copy link
Contributor

In the previous API documentation, I would often click on the examples linked and change the URL to test things out quickly.
In the new doc, I don't see an easy way to do that. There is a long form on the "try out" section but I don't see the resulting URL (although maybe it is an issue with my browser) and the form is so long, I am a bit confused.

Could we have a simple "example" tab or section (something that I could find easily) in the doc? Thanks!

@MattBlissett
Copy link
Member

I think that's a task to change the Swagger UI slightly, so the "Request URL" shown when the "Try it out" thing is clicked is a link.

The form is equivalent to the parameters in the URL.

Something seems to be broken with the /occurrence/search form.

@CecSve CecSve added the API Reference Issues relating to enhancing the 'API Reference' section of the technical documentation label Mar 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Reference Issues relating to enhancing the 'API Reference' section of the technical documentation
Projects
None yet
Development

No branches or pull requests

3 participants