Skip to content

Reference

Draft

Reference for Capsule’s developer surfaces. Each section is generated from a committed, machine-readable description artifact that the surface’s own toolchain emits and its own gate keeps current; the docs build only reads those files. Hand-written prose is limited to each section’s overview page. If a generated page is wrong, fix the source annotation. The contract is Developer Documentation.

SurfaceOverviewGenerated fromKept current by
RESTREST APIcapsule-server/openapi.jsonmise run openapi-check-kynos
Command lineCLIcapsule-cli/cli-surface.jsonmise run cli-surface-check
Swift and KotlinSDKcapsule-sdk/bindings-surface.jsonmise run gen-bindings --check
BrowserSDKcapsule-wasm/wasm-surface.d.tsmise run wasm-surface-check
Rust cratesCratesworkspace rustdoc, not committedmise run doc-check-rust

The Rust SDK page and Crates are hand-written: the Rust surface’s item-level reference is rustdoc, which is built by the Rust gate and is too large to commit.

Related: