Skip to content

Commit

Permalink
Update documentation for schema definition (dagu-org#645)
Browse files Browse the repository at this point in the history
  • Loading branch information
yohamta committed Aug 3, 2024
1 parent 7421d68 commit f419767
Showing 1 changed file with 12 additions and 0 deletions.
12 changes: 12 additions & 0 deletions docs/source/yaml_format.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <https://github.com/daguflow/dagu/blob/main/schemas/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
~~~~~~~~~~~~~~~~~~

Expand Down

0 comments on commit f419767

Please sign in to comment.