KERNIT Documentation
SDK package plan
The packaged SDKs should be generated from the versioned OpenAPI contract, tested against documented fixtures, and released only when docs, examples, and live verification agree.
Package Targets#
| Package | Language | Release contract |
|---|---|---|
@kernit/hyperlinker | Node.js and TypeScript | Typed client generated from the current OpenAPI snapshot with multipart helpers for DOCX routes. |
kernit-hyperlinker | Python | Requests-based client generated from the current OpenAPI snapshot with file helpers and response models. |
Generation Inputs#
app/docs/openapi.jsonfor routes, request fields, responses, auth, and status codes.app/docs/openapi-snapshots/2026-05-12.jsonfor reproducible versioned SDK generation.- Workflow examples for scan, resolve, review, apply, and one-step apply.
- Fixture DOCX files and expected response shapes for package tests.
Generated Artifacts#
| Artifact | Path |
|---|---|
| Node package | app/docs/sdk-packages/node |
| Python package | app/docs/sdk-packages/python |
| Build command | npm run docs:sdk:generate |
| Validation test | test/docs-sdk-packages.test.mjs |
Release Gate#
| Gate | Reason |
|---|---|
| OpenAPI diff passes | SDK generation must not hide a breaking contract change. |
| SDK artifacts match the contract | Generated package versions, client constants, and route lists must match the current OpenAPI version. |
| Docs examples pass | Public snippets and SDK methods must agree. |
| Live verification passes | The package must call the same production routes documented in the API reference. |
| Version is explicit | SDK versions should map to the OpenAPI contract version they were generated from. |
Do Not Ship Until#
Do not publish SDK packages until package tests cover scan, resolve, apply, auth failures, billing failures, rate limits, and scan-token mismatches. Until then, the SDK-style client pages remain the supported copy-paste implementation surface.
Was this page useful?Send a lightweight docs feedback event.