Reference
Complete field-by-field reference documentation for the FlowDSL specification.
Complete specification reference. Use this section when you need the exact type, constraints, and behavior of a specific field.
Spec reference
| Page | What it covers |
|---|---|
| FlowDSL Document | Top-level document fields: flowdsl, info, nodes, edges, components |
| Flow object | Flow-level fields and lifecycle |
| Node object | Node fields: operationId, kind, inputs, outputs, settings, x-ui |
| Edge object | Edge fields: from, to, delivery, when |
| DeliveryPolicy | All delivery policy fields by mode |
| RetryPolicy | Retry policy fields and backoff strategies |
| Components | packets, events, policies, nodes |
| Packets | Packet schema format and reference syntax |
| Runtime Bindings | x-runtime extension for infrastructure binding |
| Extensions (x-*) | All supported extension fields |
Node infrastructure
| Page | What it covers |
|---|---|
| Node Manifest | flowdsl-node.json format reference |
| Communication Protocols | All 9 communication protocols — gRPC, NATS, Kafka, Redis, ZeroMQ, RabbitMQ, WebSocket |
| Node Registry API | repo.flowdsl.com REST API reference |
Schema
The canonical FlowDSL JSON Schema is available at:
text
https://flowdsl.com/schemas/v1/flowdsl.schema.json
Validate a document:
shell
npx ajv-cli validate \
-s https://flowdsl.com/schemas/v1/flowdsl.schema.json \
-d my-flow.flowdsl.yaml