Skip to content

JSON Schemas reference

Every Helix YAML file is validated against a JSON Schema. The schemas live under helix/schemas/ in two groups:

  • helix/schemas/dsl/workflow.json — the top-level workflow + route schema
  • helix/schemas/components/*.json — per-scheme schemas for component URI params

Run helix validate <file.yaml> to validate a workflow file against these. helix schemas regenerates the per-component schemas from each component's Describe() so the schemas never drift from the runtime contract.

DSL schemas

  • helix/schemas/dsl/workflow.json — the workflow / route / processor schema

Component schemas (auto-generated)

Per helix/schemas/components/. The list is regenerated by helix schemas; current set includes:

amqp, chart, cron, direct, elasticsearch, file, ftp, ftps, http-server, kafka, log, mock, mongodb, mqtt, nats, pdf, rabbitmq, redis, seda, slack, smtp, sql, timer.

23 schemas exist; 67 components are registered. The gap is the schemas that haven't been generated yet. Run bin/helix schemas to update, then re-run bin/audit-docs to re-verify.

See also