Add new digest auth params for downloader integration #39642
Conversation
home-assistant
bot
added
in-progress
|
It seems that this PR is targeted against an incorrect branch. Documentation updates which apply to our current stable release should target the |
❌ Deploy Preview for home-assistant-docs failed.
|
📝 WalkthroughWalkthroughThe downloader integration documentation was updated to include three new optional data attributes— Changes
Sequence Diagram(s)No sequence diagram generated as the changes are limited to documentation updates. 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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/downloader.markdown (1)
34-36: Verify and enrich documentation for new digest auth parameters.Ensure the downloader integration code actually supports
digest_auth,username, andpassword. Also, document the default value fordigest_auth(e.g.,false) and consider adding a snippet in the JSON example showing how to supply these fields.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/downloader.markdown(1 hunks)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
home-assistant
bot
removed
the
needs-rebase
mossymaker
force-pushed
the
downloader-new-params-for-digest-auth
branch
from
fcf26f7 to
bd221cb
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
source/_integrations/downloader.markdown (1)
34-36: Fix typo and clarify valid auth_type values.
- Remove the extra period in the
auth_usernamedescription.- Recommend specifying supported authentication types (e.g.,
basic,digest) for clarity.-| `auth_type` | yes | Authentication type to use. | +| `auth_type` | yes | Authentication type to use (e.g., `basic`, `digest`). | -| `auth_username` | yes | Username to use with authentication.. | +| `auth_username` | yes | Username to use with authentication. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/downloader.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/downloader.markdown
[typographical] ~35-~35: Two consecutive dots
Context: ...es | Username to use with authentication.. | | auth_password | ...
(DOUBLE_PUNCTUATION)
🔇 Additional comments (1)
source/_integrations/downloader.markdown (1)
34-36: The previousrginvocation treated your patterns as filenames. Let’s rerun using the-eflag to specify each search pattern:#!/bin/bash # Verify new auth params in downloader integration code rg -n -e 'auth_type' -e 'auth_username' -e 'auth_password'
mossymaker
force-pushed
the
downloader-new-params-for-digest-auth
branch
from
bd221cb to
60174ff
Compare
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
source/_integrations/downloader.markdown (2)
34-36: Clarify authentication parameters usage and defaults.
Recommend specifying thatauth_usernameandauth_passwordare required whenauth_typeis provided, and document the default behavior (e.g., no authentication orbasic) whenauth_typeis omitted.
37-37: Add missing period insubdirdescription.
For consistency with other entries, append a trailing period to thesubdirdescription.
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
source/_integrations/downloader.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/downloader.markdown
[uncategorized] ~32-~32: A punctuation mark might be missing here.
Context: ...--------------------------------------- | | url | no | T...
(AI_EN_LECTOR_MISSING_PUNCTUATION)
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - home-assistant-docs
- GitHub Check: Header rules - home-assistant-docs
- GitHub Check: Pages changed - home-assistant-docs
🔇 Additional comments (2)
source/_integrations/downloader.markdown (2)
32-33: Approve table separator andurlrow formatting.
The separator line and theurlrow adhere to the existing table style and require no changes.
38-38: Approvefilenameentry consistency.
Thefilenamerow matches the table's style and conventions and needs no changes.
Proposed change
Accompanying docs changes for new digest authentication parameters for downloader integration.
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit