Document API endpoints on the hosted docs site

[CloudNiner]

Improvement

Looks like the endpoints are listed in the README on GitHub but I clicked around the docs site for far too long until remembered that's where they were. 🤦

Notes + Context

Would also be cool to note in the hosted docs that there's an open-api spec available at /open-api/spec.yaml which was super helpful, assuming that is kept up to date automatically via code introspection or docstrings.

[jisantuc]

The open api spec is kept up-to-date by tapir. As a result it also respect server configuration options, e.g. it won't list the tile endpoints if you haven't asked for them.

We also have a link to the open API docs on the landing page if you have a running server, but there isn't a stable location to link to for the OpenAPI spec since not every Franklin instance will run with the same options. Should the docs site let people know where they can view the API docs on localhost if they have a server running?

[CloudNiner]

The open api spec is kept up-to-date by tapir. As a result it also respect server configuration options, e.g. it won't list the tile endpoints if you haven't asked for them.

Well that's pretty cool.

Yeah, a note in the docs that tells people where to find the OpenAPI Spec on their running franklin instance seems like a good way to point people in the right direction.