Skip to content

docs: clarify FROZEN is the legacy name for WAITING run status #4301

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
ANSHSINGH050404 wants to merge 1 commit into from
Closed

docs: clarify FROZEN is the legacy name for WAITING run status #4301

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
7 changes: 7 additions & 0 deletions docs/runs.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,6 +45,13 @@ currently being executed by a worker.
<Icon icon="hourglass" iconType="solid" color="#878C99" size={17} /> **Waiting**: You have used a
[triggerAndWait()](/triggering#yourtask-triggerandwait), [batchTriggerAndWait()](/triggering#yourtask-batchtriggerandwait) or a [wait function](/wait). When the wait is complete, the task will resume execution.

<Note>
Older API versions may report this state as **`FROZEN`**. Current API versions map the same
internal paused/waiting-to-resume states to **`WAITING`**. If you branch on status strings from
the API, treat `FROZEN` as equivalent to `WAITING` for compatibility with clients that omit the
current API version header.
</Note>

### Final states

<Icon icon="circle-check" iconType="solid" color="#28BF5C" size={17} /> **Completed**: The task has successfully
Expand Down