Skip to content

DSL reference

The Helix DSL is the YAML format you write to describe routes, components, and processor pipelines.

Pages

Page What it covers Source
workflow Top-level YAML: helix:, routes:, from:, steps:, processors: pkg/dsl/yaml_loader.go
rest The REST DSL: rest: blocks for HTTP-shaped routes pkg/dsl/rest.go
openapi Import an OpenAPI spec and generate routes pkg/dsl/rest_openapi.go
templates Route templates (parameterized snippets) pkg/template/

How the DSL is loaded

  1. YAML → Go structs via pkg/dsl/yaml_loader.go
  2. The Reifier turns the route definition into an in-memory pipeline (pkg/dsl/reifier.go)
  3. Each step is resolved to a Component via its URI scheme, registered in the Helix context
  4. The route is registered with the engine and the consumer is started

See also