From 051c279063f6bd26aa2f77b8346be1014904f0e7 Mon Sep 17 00:00:00 2001 From: Yota Hamada Date: Sat, 3 Aug 2024 14:36:07 +0900 Subject: [PATCH] Update docs --- docs/source/yaml_format.rst | 12 ++++++++++++ 1 file changed, 12 insertions(+) diff --git a/docs/source/yaml_format.rst b/docs/source/yaml_format.rst index e59bb6521..c671c2372 100644 --- a/docs/source/yaml_format.rst +++ b/docs/source/yaml_format.rst @@ -34,6 +34,18 @@ The command can be string or list of strings. The list of strings is useful when .. _specifying working dir: +Schema Definition +~~~~~~~~~~~~~~~~~~ + +We have a schema definition for the DAG file. The schema definition is used to validate the DAG file. The schema definition is available at `dag.schema.json `_. This schema can be used by IDEs to provide auto-completion and validation. I.e.,: + +.. code-block:: yaml + + # yaml-language-server: $schema=https://raw.githubusercontent.com/daguflow/dagu/main/schemas/dag.schema.json + steps: + - name: step 1 + command: echo hello + Working Directory ~~~~~~~~~~~~~~~~~~