dag.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "type": "object",
  "description": "Schema for Dagu YAML format",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the DAG"
    },
    "description": {
       "type": "string",
       "description": "Description of the DAG"
    },
    "schedule": {
      "type": "string",
      "pattern": "(\\*|[0-5]?[0-9]|\\*\/[0-9]+)\\s+(\\*|1?[0-9]|2[0-3]|\\*\/[0-9]+)\\s+(\\*|[1-2]?[0-9]|3[0-1]|\\*\/[0-9]+)\\s+(\\*|[0-9]|1[0-2]|\\*\/[0-9]+|jan|feb|mar|apr|may|jun|jul|aug|sep|oct|nov|dec)\\s+(\\*\/[0-9]+|\\*|[0-7]|sun|mon|tue|wed|thu|fri|sat)\\s*(\\*\/[0-9]+|\\*|[0-9]+)?",
      "description": "Cron schedule expression for the DAG"
    },
    "group": {
      "type": "string",
      "description": "Group name to organize DAGs"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of free tags to categorize DAGs"
    },
    "env": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of environment variables accessible to the DAG"
    },
    "logDir": {
      "type": "string",
      "description": "Directory for log files"
    },
    "restartWaitSec": {
      "type": "integer",
      "description": "Seconds to wait before restarting DAG process"
    },
    "histRetentionDays": {
      "type": "integer",
      "description": "Days to retain execution history"
    },
    "delaySec": {
      "type": "integer",
      "description": "Seconds delay between steps"
    },
    "maxActiveRuns": {
      "type": "integer",
      "description": "Max parallel running steps"
    },
    "params": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of default parameters accessible as $1, $2, etc"
    },
    "preconditions": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "condition": {
            "type": "string"
          },
          "expected": {
            "type": "string"
          }
        }
      },
      "description": "List of conditions to check before running DAG/step"
    },
    "mailOn": {
      "type": "object",
      "properties": {
        "failure": {
          "type": "boolean"
        },
        "success": {
          "type": "boolean"
        }
      },
      "description": "Whether to send email on failure/success"
    },
    "maxCleanUpTimeSec": {
      "type": "integer",
      "description": "Max time to wait before killing steps after TERM signal"
    },
    "handlerOn": {
      "type": "object",
      "properties": {
        "success": {
          "type": "object",
          "properties": {
            "command": {
              "type": "string"
            }
          }
        },
        "failure": {
          "type": "object",
          "properties": {
            "command": {
              "type": "string"
            }
          }
        },
        "cancel": {
          "type": "object",
          "properties": {
            "command": {
              "type": "string"
            }
          }
        },
        "exit": {
          "type": "object",
          "properties": {
            "command": {
              "type": "string"
            }
          }
        }
      },
      "description": "Commands to execute on DAG/step events"
    },
    "steps": {
      "type": "array",
      "required": ["name"],
      "items": {
        "type": "object",
        "properties": {
          "name": {
            "type": "string"
          },
          "depends": {
            "type": "array",
            "items": {
              "type": "string"
            },
            "description": "List of step names this step depends on"
          },
          "description": {
            "type": "string"
          },
          "dir": {
            "type": "string"
          },
          "command": {
            "type": "string"
          },
          "stdout": {
            "type": "string"
          },
          "output": {
            "type": "string"
          },
          "script": {
            "type": "string"
          },
          "signalOnStop": {
            "type": "string"
          },
          "mailOn": {
            "type": "object",
            "properties": {
              "failure": {
                "type": "boolean"
              },
              "success": {
                "type": "boolean"
              }
            }
          },
          "continueOn": {
            "type": "object",
            "properties": {
              "failure": {
                "type": "boolean"
              },
              "skipped": {
                "type": "boolean"
              }
            }
          },
          "retryPolicy": {
            "type": "object",
            "properties": {
              "limit": {
                "type": "integer"
              },
              "intervalSec": {
                "type": "integer"
              }
            }
          },
          "repeatPolicy": {
            "type": "object",
            "properties": {
              "repeat": {
                "type": "boolean"
              },
              "intervalSec": {
                "type": "integer"
              }
            }
          },
          "preconditions": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "condition": {
                  "type": "string"
                },
                "expected": {
                  "type": "string"
                }
              }
            }
          }
        }
      },
      "description": "List of steps to execute in the DAG"
    }
  }
}