Rust API Reference

This section contains the complete Rust API documentation for all Brokkr crates, automatically generated from source code doc comments using plissken.

These docs are regenerated on every build, so they always reflect the current state of the codebase.

All modules lists every page with its summary.

Crates

• brokkr-broker — The main control plane and API server
• brokkr-agent — The agent that applies resources to Kubernetes clusters
• brokkr-models — Shared data models and database schema
• brokkr-utils — Utilities, configuration, and helpers

Python SDK

plissken also writes the API pages of the Python SDK (sdks/python/brokkr):

• brokkr — The package
• client — BrokkrClient, the client
• errors — BrokkrError, the typed error

Client SDKs

The pages above document Brokkr’s internal Rust crates. If you’re consuming the broker API from your own code, use one of the generated client SDKs instead — all three are produced from the same OpenAPI spec and kept in lockstep with the broker version:

• Client SDKs overview — shared shape, auth, versioning, error handling
• Rust SDK — brokkr-client crate (wraps the progenitor-generated client)
• Python SDK — brokkr-client distribution
• TypeScript SDK — @colliery-io/brokkr-client package
• Regenerating SDKs — how the SDKs are produced from the spec

Interactive API Documentation

For REST API endpoint documentation (request/response schemas, authentication, try-it-out), see the API Reference or access Swagger UI directly at http://<broker-url>/swagger-ui.

Looking for higher-level guides? Return to the main documentation.