Repository navigation
integrations: Fix API URL in Home Assistant documentation. - #40197
Merged
Merged
Conversation
7 of 13 tasks
There was a problem hiding this comment.
Copilot review overview
🟢 Approval recommended
No unresolved review issues remain.
Review effort: Lite
Findings: None
What changed in this PR
Updates the Home Assistant documentation to use the valid api_url template variable.
Changes:
- Replaces undefined
external_api_uri. - Corrects the documented API resource URL.
| File | Description |
|---|---|
zerver/webhooks/homeassistant/doc.md |
Corrects the Home Assistant API URL template. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
laurynmm
added
the
integration review
The configuration.yaml example used `external_api_uri` as a template variable, which rendered as an empty string since that context variable was removed in commit 271a9f0. It was likely added to this documentation as a copy and paste error. Updated the documentation to us the `api_url` context variable instead.
laurynmm
force-pushed
the
fix-homeassistant-doc-api-url
branch
from
October 2, 2026 15:15
17f7314 to
f66e989
Compare
Collaborator
|
@Aditya-XR - Thanks for moving this to a separate change. I've updated the commit message to note when the |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
The
configuration.yamlexample in the Home Assistant integration doc usedexternal_api_uri, which isn't defined for that template, so it rendered as an empty string and the example showed a brokenresource: http: v1/external/homeassistantURL. This uses{{ api_url }}, like the rest of the same doc.Split out of #40191 at the reviewer's request.
Fixes: part of #23380.
How changes were tested:
Opened the Home Assistant integration doc in the dev server before and after the change and checked the rendered
resource:URL.Screenshots and screen captures:
Self-review checklist
(variable names, code reuse, readability, etc.).
Communicate decisions, questions, and potential concerns.
Individual commits are ready for review (see commit discipline).
Completed manual review and testing of the following: