API internals reference
This section contains auto-generated code documentation from the Aucert codebase. References are generated weekly by CI and updated via automated PRs.
Available references
| Language | Source | Generator | Status |
|---|---|---|---|
| Kotlin | backend/platform/ | Dokka | Placeholder — plugin not yet added |
| TypeScript | frontend/packages/ui/ | TypeDoc | Placeholder — not yet installed |
| Python | ml/ | Sphinx | Placeholder — not yet configured |
| Protobuf | proto/ | protoc-gen-doc | Available — manually documented |
info
Code reference generation runs weekly via CI (.github/workflows/docs-code-reference.yml) and can be triggered manually. Most generators are placeholder until the corresponding codebases are fully scaffolded.
Generation
# Generate all references (runs what's available)
./docs/scripts/generate-code-reference.sh all
# Generate only Protobuf reference
./docs/scripts/generate-code-reference.sh proto
Protobuf schemas (source of truth)
The proto/ directory contains the canonical inter-layer contracts:
- pipeline.proto —
MCPMessage,TestRunRequest,TestRunResult,BugReport - knowledge-graph.proto —
KGQuery,KGResponse,KGNode,KGEdge
See the 5-layer deep dive for how these types flow through the pipeline.