Skip to content

wait: document value reference support in wait fields #54

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

Closed
ianwalkeruk wants to merge 1 commit into from
Closed

wait: document value reference support in wait fields #54

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: 10 additions & 2 deletions step-types/wait.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,14 @@ Use the step-level `timeout_sec` field to set an overall maximum wait time.

## Value References

`path`, `method`, `headers`, and `body` accept [value references](/writing-workflows/template-variables), such as `${params.name}` or a previous step's output, and resolve when the step starts.
All `wait` fields accept [value references](/writing-workflows/template-variables), such as `${params.name}` or a previous step's output, and resolve when the step starts. For example, an earlier step can compute the moment to wait for:

`duration`, `until`, `url`, `state`, `status`, `poll_interval`, and `request_timeout` are validated as written when the DAG is built, before references resolve. A reference such as `until: ${params.deadline}` is rejected before the DAG runs.
```yaml
steps:
- id: compute
action: wait.until
with:
until: ${params.deadline}
```

A value that still holds a reference when the DAG is built skips strict validation until the reference resolves at run time. Literal values are still validated strictly at build time: an invalid literal duration, timestamp, URL, state, or status is rejected before the DAG runs, while a reference that resolves to an invalid value fails the step at execution.
Loading