Skip to content

docs(http): add output variables for dependsOn checks #476

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
Copilot wants to merge 2 commits into from
Closed

docs(http): add output variables for dependsOn checks #476

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e9549b9
Initial plan
Copilot Feb 11, 2026
fc23a68
docs(http): add output variables documentation for dependsOn checks
Copilot Feb 11, 2026
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
21 changes: 21 additions & 0 deletions canary-checker/docs/reference/1-http.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -138,6 +138,27 @@ Eg: In the following spec, the var `db`, defined in `env`, is available as `{{.d
</div>
</details>

### Referencing Outputs from Dependent Checks

When using `dependsOn` to create dependencies between checks, you can access outputs from other checks by name. This enables <CommonLink to="request-chaining">request chaining</CommonLink> for multi-step workflows.

| Variable | Description | Scheme |
| -------- | ----------- | ------ |
| `outputs.<checkName>.json` | Parsed JSON response body from the named check | `map[string]any` |
| `outputs.<checkName>.code` | HTTP response status code from the named check | `int` |
| `outputs.<checkName>.headers` | Response headers from the named check | `map[string][]string` |
| `outputs.<checkName>.body` | Raw response body from the named check | `string` |

<details summary="Example: Using outputs from dependent checks">

<div>
```yaml title="http-depends-on.yaml" file=<rootDir>/modules/canary-checker/fixtures/minimal/http_depends_on_pass.yaml
```

In this example, the `get-profile` check depends on the `login` check and uses the token from the login response via `$(.outputs.login.json.token)`.
</div>
</details>

See <CommonLink to="gotemplate" anchor="escaping">Escaping variables</CommonLink>

## Metrics
Expand Down