Kyub API Documentation

The documentation is still a work-in-progress. It may therefore be incomplete and may change structurally at some point.

OpenAPI Documentation

Anything documented in the openAPI documentation you can generate as described below is up-to-date.

The documentation is currently written in a way that's optimized for use with redoc by Redocly. You can compile a zero-dependency HTML file from the documentation files contained in the openapi directory using the generateApiDocs.sh script contained in this directory. First, install the @redocly/cli package using, e.g., npm.

npm i -g @redocly/cli

For other installation options, refer to this page by Redocly.

Once this is done, you can simply execute generateApiDocs.sh in your shell (git bash on Windows).

Database Schema Documentation

As of right now the DB schema documentation schema.dbml is not up-to-date, consume it carefully.