Skip to content

Conversation

@adityathebe
Copy link
Member

@adityathebe adityathebe commented Feb 6, 2026

Fixed template body variables table:

  • Changed metadata.canary.
  • Added missing check.* and canary.id variables

Summary by CodeRabbit

  • Documentation
    • Output field renamed from body to content in request chaining documentation
    • Expanded templating variables reference with new canary.* and check.* namespaced variables for enhanced template customization
    • New dependency output variables section added for accessing outputs from dependent checks

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'
@vercel
Copy link

vercel bot commented Feb 6, 2026

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated (UTC)
docs Ready Ready Preview Feb 11, 2026 9:01am

Request Review

@netlify
Copy link

netlify bot commented Feb 6, 2026

Deploy Preview for canarychecker ready!

Name Link
🔨 Latest commit 2089c83
🔍 Latest deploy log https://app.netlify.com/projects/canarychecker/deploys/698c453cf4474c00082ba886
😎 Deploy Preview https://deploy-preview-472--canarychecker.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

Copy link

Copilot AI commented Feb 11, 2026

@moshloop I've opened a new pull request, #476, to work on those changes. Once the pull request is ready, I'll request review from you.

- Add outputs.<checkName>.* variables available when dependsOn is configured
- Fix body -> content in request-chaining.mdx to match actual field name
@coderabbitai
Copy link

coderabbitai bot commented Feb 11, 2026

Walkthrough

Documentation updates rename the public-facing output field from outputs.<checkName>.body to outputs.<checkName>.content in request chaining, and expand HTTP reference templating documentation to introduce namespaced canary.* and check.* variables alongside a new dependency output variables subsection.

Changes

Cohort / File(s) Summary
Request Chaining Output Field
canary-checker/docs/concepts/request-chaining.mdx
Renamed output field from outputs.<checkName>.body to outputs.<checkName>.content in examples and reference tables.
HTTP Reference Templating
canary-checker/docs/reference/1-http.mdx
Expanded templating variable table to include namespaced canary.* (name, namespace, labels, id) and check.* (name, id, description, labels, endpoint) variables. Added "Dependency Output Variables" subsection documenting outputs.<checkName>.* fields (pass, message, duration, code, headers, content, json, elapsed, sslAge).
🚥 Pre-merge checks | ✅ 3
✅ Passed checks (3 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title correctly summarizes the main changes: fixing incorrect template variables in HTTP documentation, specifically the renaming of body to content and the replacement of incorrect metadata.* variables with canary.* and check.* variables.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch http-template-docs-fix

No actionable comments were generated in the recent review. 🎉


Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@adityathebe adityathebe requested a review from moshloop February 11, 2026 09:02
@moshloop moshloop merged commit 68f9c1b into main Feb 12, 2026
15 checks passed
@moshloop moshloop deleted the http-template-docs-fix branch February 12, 2026 06:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants