From b523cf528571be843ed8858b75df8ef4a0e7f7d1 Mon Sep 17 00:00:00 2001
From: Aditya Thebe <contact@adityathebe.com>
Date: Fri, 6 Feb 2026 19:14:38 +0545
Subject: [PATCH] docs(http): fix incorrect template body variables

The documentation incorrectly listed 'metadata.*' variables which
don't exist in the template context. Fixed to use the correct
'canary.*' and added missing 'check.*' variables.

Changes:
- Fixed 'metadata.name' -> 'canary.name'
- Fixed 'metadata.namespace' -> 'canary.namespace'
- Fixed 'metadata.labels' -> 'canary.labels'
- Added missing 'canary.id'
- Added missing 'check.*' variables (name, id, description, labels, endpoint)
- Improved table with descriptions column
- Fixed env vars description to use 'env' instead of 'envVars'
---
 canary-checker/docs/reference/1-http.mdx | 24 +++++++++++++++---------
 1 file changed, 15 insertions(+), 9 deletions(-)

diff --git a/canary-checker/docs/reference/1-http.mdx b/canary-checker/docs/reference/1-http.mdx
index 44344fb9..43f21f9d 100644
--- a/canary-checker/docs/reference/1-http.mdx
+++ b/canary-checker/docs/reference/1-http.mdx
@@ -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">