OpenAPI specification for REST API

[bablokb]

Maybe a task for Claude: create an OpenAPI specification of the REST API. With the spec, various generators can create client SDKs in arbitrary languages.

[dmellok]

Good idea! I'll get on this tomorrow.

[dmellok]

@bablokb https://dmellok.github.io/tesserae/dev/openapi/

[bablokb]

Great! I am mostly not at home today, but I will give it a try starting Thursday. Although CircuitPython is only a subset of CPython, the Python-generator should give me most of what I need.

[bablokb]

Works, but the generated code is very generic and too bloated for embedded systems. I will write a minimal library myself instead.

Suggestion: add a note about the installation of the generator:

pip install openapi-generator-cli[jdk4py]

If there is already a jdk-runtime on the system, the suffix is not necessary.

[dmellok]

Thanks for trying it. Fair call: openapi-generator's output is too
heavy for an MCU target. The spec is still useful as a documented
contract for tools running on a regular machine, but you're right
that the generator path doesn't translate cleanly to embedded.

Will add the jdk4py note to docs/dev/openapi.md.

If you publish your library and want it linked from the docs, send
me the repo.