caelum0x d3ba32ac12 fix(sdk): make the API key optional in the Python, JS and lite SDKs
A self-hosted server needs no key, but all three SDKs threw before the first
request. The key is now optional: without one no Authorization header is sent.
A key that is present is validated as before.

Release prep: openjev-client 0.7.2, @openjev/sdk 0.6.1, @openjev/lite 0.2.1.
2026-11-11 05:36:35 +03:00
..

Generate the API reference

From the SDK source checkout, run:

npm run docs

This installs the locked documentation dependencies and generates Markdown reference pages and navigation.json in build/docs/. No API key is needed.

To regenerate after editing source comments without reinstalling dependencies:

npm run --prefix docs build

TypeDoc reads the public exports from src/index.ts and their JSDoc comments. Update the source comments to change the reference. Generated files are ignored by Git, and generation fails on warnings.

The documentation toolchain uses TypeScript 6 because TypeDoc does not yet support the SDK's TypeScript 7 compiler. Its dependencies are isolated in docs/; the SDK build uses its own compiler.