Reference#
The guides show how to build and operate an application. These pages describe the contracts and internal workings behind them. Open a guide first, then use its linked reference when you need exact boundaries, failure behavior or advanced wiring.
Application setup and request handling#
Appendix: Configuration Reference — configuration resolution, scoped keys and the complete key catalogue.
Appendix: Container Lifecycle — AppScope, RequestScope, binding resolution and disposal.
Appendix: Routing & Validation — route matching, binding, validation and OpenAPI schema rules.
Appendix: Middleware — pipeline order and built-in middleware contracts.
Appendix: Sessions Reference — cookie, CSRF, expiry and store lifecycle.
Appendix: Authentication — bearer header, JWT keys, validation and failure contracts.
Data and background work#
Appendix: Databases — database drivers, sessions, transactions, options and connection registration.
Appendix: Query Builder — query shapes, dialect behavior and advanced builder operations.
Appendix: Redis — transport deadlines, Cluster routing and cache mechanisms.
Appendix: Queue Contracts — delivery, worker lifecycle and backend mechanisms.
Integrations#
Appendix: HTTP client contracts — URL, header, deadline, response and transport contracts.
Appendix: AWS SigV4 contracts — signed-origin, credential, canonical request and failure contracts.
Appendix: Storage Reference — local publication, path confinement, symlinks and S3 failure behavior.
Appendix: Search contracts — search configuration, client results and transport failure vocabulary.
Appendix: MCP Reference — protocol, HTTP headers, errors and request lifecycle for application tools and resources.
Appendix: MCP Documentation Server Reference — documentation server install, update, protocol and fetch contracts.
Appendix: Orbitron — Orbitron’s command schemas, installed-source tools, MCP catalogue, project wiring and trust boundary.
Runtime and verification#
Appendix: Runtime Reference — request-body staging, forwarded headers, runtime adapters, Fiber scheduling and compiled artifacts.
Appendix: Testing Reference — test-client request construction, loop liveness and runtime conformance.
Appendix: Observability Reference — tracing export, Fiber scope ownership and fingerprint construction.
Repository and release details#
Appendix: System Layout — framework namespace and file layout.
Appendix: Satellite Packages — satellite package layout.
Appendix: Continuous Integration — what the CI jobs verify.
Appendix: Contributing to Kinetis — working in the monorepo.