Skip to content

docs(http): fix incorrect template body variables #472

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

Open
adityathebe wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(http): fix incorrect template body variables #472

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
24 changes: 15 additions & 9 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 @@ -106,15 +106,21 @@ The above canary (`http-check.yaml`) is functionally equivalent to `http-check-e

## Template Body Variables

| Name | Scheme |
| ----------------------------- | ------------------- |
| `metadata.name` | string |
| `metadata.namespace` | _string_ |
| `metadata.labels` | _map[string]string_ |
| `{fields from []envVars}` | any |

Variables defined in `envVars` are available to template with the name that's configured on the spec.
Eg: In the following spec, the vars `my_secret_path` and `my_secret_var`, defined in `envVars`, are available during templating.
| Name | Description | Scheme |
| --------------------- | ------------------------------ | ------------------- |
| `canary.name` | Canary name | `string` |
| `canary.namespace` | Canary namespace | `string` |
| `canary.labels` | Canary labels | `map[string]string` |
| `canary.id` | Persisted Canary ID | `string` |
| `check.name` | Check name | `string` |
| `check.id` | Check ID | `string` |
| `check.description` | Check description | `string` |
| `check.labels` | Check labels | `map[string]string` |
| `check.endpoint` | Check endpoint/URL | `string` |
| `{envVar.name}` | Environment variables defined in `env` | `any` |

Variables defined in `env` are available to template with the name that's configured on the spec.
Eg: In the following spec, the var `db`, defined in `env`, is available as `{{.db}}` during templating.

<details summary="Templating request body from env variables">

Expand Down