windmill-yaml-validator
Version:
YAML validator for Windmill flow, schedule, and trigger files
158 lines (157 loc) • 5.95 kB
JSON
{
"type": "object",
"properties": {
"script_path": {
"type": "string",
"description": "Path to the script or flow to execute when triggered"
},
"is_flow": {
"type": "boolean",
"description": "True if script_path points to a flow, false if it points to a script"
},
"labels": {
"type": "array",
"items": {
"type": "string"
},
"default": []
},
"draft_only": {
"description": "True when this row is a per-user draft with no deployed\ntrigger at the same path. Set by list endpoints when\n`include_draft_only=true` synthesizes the row from the\ndraft. Frontend renders a \"Draft\" badge.\n",
"type": "boolean"
},
"is_draft": {
"description": "True when the authed user has a per-user draft at this path\n(over a deployed row or a synthesized draft-only row).\nFrontend appends a `*` to the displayed name.\n",
"type": "boolean"
},
"kafka_resource_path": {
"type": "string",
"description": "Path to the Kafka resource containing connection configuration"
},
"group_id": {
"type": "string",
"description": "Kafka consumer group ID for this trigger"
},
"topics": {
"type": "array",
"items": {
"type": "string"
},
"description": "Array of Kafka topic names to subscribe to"
},
"filters": {
"type": "array",
"items": {
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {}
},
"required": [
"key",
"value"
]
}
},
"filter_logic": {
"type": "string",
"enum": [
"and",
"or"
],
"default": "and",
"description": "Logic to apply when evaluating filters. 'and' requires all filters to match, 'or' requires any filter to match."
},
"auto_offset_reset": {
"type": "string",
"enum": [
"latest",
"earliest"
],
"default": "latest",
"description": "Initial offset behavior when consumer group has no committed offset. 'latest' starts from new messages only, 'earliest' starts from the beginning."
},
"auto_commit": {
"type": "boolean",
"default": true,
"description": "When true (default), offsets are committed automatically after receiving each message. When false, you must manually commit offsets using the commit_offsets endpoint."
},
"error_handler_path": {
"type": "string",
"description": "Path to a script or flow to run when the triggered job fails"
},
"error_handler_args": {
"type": "object",
"description": "Arguments to pass to the error handler",
"additionalProperties": true
},
"retry": {
"type": "object",
"description": "Retry configuration for failed executions",
"properties": {
"constant": {
"type": "object",
"description": "Retry with constant delay between attempts",
"properties": {
"attempts": {
"type": "integer",
"description": "Number of retry attempts"
},
"seconds": {
"type": "integer",
"description": "Seconds to wait between retries"
}
}
},
"exponential": {
"type": "object",
"description": "Retry with exponential backoff (delay doubles each time)",
"properties": {
"attempts": {
"type": "integer",
"description": "Number of retry attempts"
},
"multiplier": {
"type": "integer",
"description": "Multiplier for exponential backoff"
},
"seconds": {
"type": "integer",
"minimum": 1,
"description": "Initial delay in seconds"
},
"random_factor": {
"type": "integer",
"minimum": 0,
"maximum": 100,
"description": "Random jitter percentage (0-100) to avoid thundering herd"
}
}
},
"retry_if": {
"type": "object",
"description": "Conditional retry based on error or result",
"properties": {
"expr": {
"type": "string",
"description": "JavaScript expression that returns true to retry. Has access to 'result' and 'error' variables"
}
},
"required": [
"expr"
]
}
}
}
},
"required": [
"script_path",
"is_flow",
"kafka_resource_path",
"group_id",
"topics",
"filters"
]
}