Reference

Lookup material for StoatFlow — configuration keys, REST API, the Gradle plugin and Maven build references, the Kafka Streams compatibility matrix, the metrics catalogue, and the glossary.

Fact-only lookup material. These pages enumerate the full surface — every configuration key, every REST endpoint, every Gradle DSL property and Maven <properties> key, the Kafka Streams DSL parity status, every Prometheus meter, and the project's vocabulary. For how-to and conceptual guidance, see Building, Configuration, and Runtime.

Reference pages

Configuration reference

Every stoatflow.* and runtime.* configuration key — type, default, and description.

REST API reference

Every HTTP endpoint the runtime exposes — path, method, and response shape.

Gradle plugin reference

The io.stoatflow convention plugin — the stoatflow { } extension DSL, tasks, and defaults.

Maven reference

The stoatflow-bom, stoatflow-parent, and stoatflow-maven-plugin — the artifacts, <properties> keys, and goals.

KS compatibility matrix

Kafka Streams DSL parity — which operators are implemented, partial, or StoatFlow extensions.

Metrics reference

Every Prometheus meter on /metrics — name, type, tags, and what it measures, grouped by area.

Glossary

Definitions of StoatFlow terms — lanes, commit barriers, watermarks, epochs, and more.

Migration carrying state

What it means to carry state across a migration to StoatFlow — reusing changelog topics, offset handling, how restoration rebuilds local state, and what is and is not supported for in-place reuse.

Configuration reference

Curated reference of the StoatFlow configuration keys — stoatflow.* (engine) and runtime.* (HTTP, metrics, health) — with type, default, and a one-line description per key.