API documentation included with lemonade server

[ckuethe]

Documentation Page / Section

https://lemonade-server.ai/docs/server/server_spec/

What's Missing or Wrong

Following on to #1616 it would be nice to have a local copy of the API documentation, especially the lemonade-specific parts. I see two main benefits:

1. the API documentation would inherently match the running server version. Maybe there's a new endpoint, or one was removed in the development/latest version. That doesn't matter as much as long as the server can describe the API it supports.
2. improved offline support. It seems like everybody has agreed on OpenAI-compatible endpoints, with a little bit of Ollama-compatible pixie dust, and there are bindings for every language. We don't really care about which REST methods are available for the standard operations .. but the lemonade-specific details are definitely worth documenting.

Suggested Improvement

Include a copy of the API documentation for the running server version, and make it accessible over the network. This could be an OpenAPI spec, a pretty swagger endpoint, a /docs path that just returns a markdown file, some server-side magic to automatically return HTML or JSON depending on the value of the Content-Type header ... I could work with any of these.

[jeremyfowers]

Thanks for filing this! I think it would be a nice addition.

@superm1 can you please comment on whether including the documentation (in either .md or .html format) would cause packaging headaches with Debian?

[superm1]

Debian loves offline documentation. If it grows big we should split it to a 3rd package (lemonade-docs), but otherwise as long as it matches the license of the project and doesn't pull fonts from the web do it!

[jeremyfowers]

Awesome!

[ckuethe]

Just gonna say that just the release notes for git as installed on my machine are 3MB. Release notes, not the manpages... and you could fit a lot of basic lemonade API documentation into a few hundred KB.