Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update documentation for schema definition #645

Merged
merged 1 commit into from
Aug 3, 2024
+12 −0
Merged

Update documentation for schema definition #645

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 12 additions & 0 deletions docs/source/yaml_format.rst
View file
Open in desktop
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
Loading