Reference
DraftReference 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.
Published
Section titled “Published”| Surface | Overview | Generated from | Kept current by |
|---|---|---|---|
| REST | REST API | capsule-server/openapi.json | mise run openapi-check-kynos |
| Command line | CLI | capsule-cli/cli-surface.json | mise run cli-surface-check |
| Swift and Kotlin | SDK | capsule-sdk/bindings-surface.json | mise run gen-bindings --check |
| Browser | SDK | capsule-wasm/wasm-surface.d.ts | mise run wasm-surface-check |
| Rust crates | Crates | workspace rustdoc, not committed | mise 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:
- The REST surface-to-transport map is API Surfaces, and the contract rules server code follows are API Practices.
- Code module to owning design doc is the Module Map.