gbif / tech-docs

This is an integrated technical documentation site for GBIF.org
https://techdocs.gbif.org
0 stars 2 forks source link

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

Open ManonGros opened 5 months ago

ManonGros commented 5 months ago

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 commented 4 months ago

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.