Update pi_hole.markdown for API V6 #39459
Conversation
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
📝 WalkthroughWalkthroughThe Pi-hole integration documentation was updated to provide clearer descriptions, specify typical port values, and clarify the handling of SSL and API credentials. New configuration options for API key/app password and SSL settings were added, with distinctions between Pi-hole versions. Action parameter explanations were also refined for accuracy. Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant Documentation
participant Pi-hole
User->>Documentation: Reads integration setup instructions
Documentation-->>User: Provides details (host, port, API key/app password, SSL options)
User->>Pi-hole: Configures integration using provided instructions
Pi-hole-->>User: Responds according to specified version and configuration
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 (
|
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (4)
source/_integrations/pi_hole.markdown (4)
36-36: Grammar and punctuation in Location description
Capitalize the sentence and add a comma after “API” for clarity.
Apply this diff:-| `Location` | the path to the admin page. In the version 6 API this will be ignored. | /admin | +| `Location` | The path to the admin page. In version 6 API, this will be ignored. | /admin |🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...ath to the admin page. In the version 6 API this will be ignored. | /admin | | `API...(AI_HYDRA_LEO_MISSING_COMMA)
38-39: Fix SSL certificate wording
Two minor grammar fixes: use “a certificate” instead of “an Certificate” and simplify the verify description.-| `Uses an SSL certificate` | Whether your Pi-hole has an Certificate, typically true for `https` connections and false for `http`. | :white_check_mark: | +| `Uses an SSL certificate` | Whether your Pi-hole has a certificate (true for `https`, false for `http`). | :white_check_mark: | -| `Verify SSL certificate` | Whether to use verify your Pi-hole's certificate, ignored in Pi-hole API version 5. | :white_check_mark: | +| `Verify SSL certificate` | Whether to verify your Pi-hole's certificate (ignored in API v5). | :white_check_mark: |🧰 Tools
🪛 LanguageTool
[misspelling] ~38-~38: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...certificate| Whether your Pi-hole has an Certificate, typically true forhttps`...(EN_A_VS_AN)
37-37: Consolidate API Key and App Password instructions
The table entry and the following paragraphs describe the same steps for obtaining credentials. Consider merging into one guided note or linking to a separate “Configuration” section to reduce duplication.Also applies to: 43-45
57-58: Clarifydurationtype and format
timedeltamay be unclear for users. Recommend specifying the string format (e.g.,"HH:MM") and updating the type accordingly.-| `duration` | `True` | timedelta | Time for which Pi-hole should be disabled. `'0'` will enable blocking indefinitely. | +| `duration` | `True` | string | Duration in `"HH:MM"` format (e.g., `"00:30"`). Use `'0'` for indefinite blocking. |
📜 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/pi_hole.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/pi_hole.markdown
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...ath to the admin page. In the version 6 API this will be ignored. | /admin | | `API...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~38-~38: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...certificate| Whether your Pi-hole has an Certificate, typically true forhttps`...
(EN_A_VS_AN)
⏰ 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 (1)
source/_integrations/pi_hole.markdown (1)
33-34: Host and Port descriptions look clear and accurate
The reworded descriptions forHostandPortcorrectly reflect typical values and usage.
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (6)
source/_integrations/pi_hole.markdown (6)
36-36: Capitalize description and refine grammar.Start the description with a capital letter and adjust phrasing for consistency:
-| `Location` | the path to the admin page. In the version 6 API this will be ignored. | /admin | +| `Location` | The path to the admin page. In API version 6, this will be ignored. | /admin |🧰 Tools
🪛 LanguageTool
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...ath to the admin page. In the version 6 API this will be ignored. | /admin | | `API...(AI_HYDRA_LEO_MISSING_COMMA)
37-37: Unify Settings path references.Use consistent terminology for the Settings UI:
-| `API Key or App Password` | This can be found in your Pi-hole's Settings -> API (expert mode). | `585a2fe...` | +| `API Key or App Password` | This can be found in your Pi-hole's _Settings > Web Interface/API_ (Expert mode). | `585a2fe...` |
38-38: Fix indefinite article and improve phrasing.Use "a certificate" and tighten the wording:
-| `Uses an SSL certificate` | Whether your Pi-hole has an Certificate, typically true for `https` connections and false for `http`. | {% icon "openmoji:check-mark" %} | +| `Uses an SSL certificate` | Whether your Pi-hole has a certificate (true for `https`, false for `http`). | {% icon "openmoji:check-mark" %} |🧰 Tools
🪛 LanguageTool
[misspelling] ~38-~38: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...certificate| Whether your Pi-hole has an Certificate, typically true forhttps`...(EN_A_VS_AN)
39-39: Correct phrasing to remove redundancy.Remove redundant words and improve parentheses usage:
-| `Verify SSL certificate` | Whether to use verify your Pi-hole's certificate, ignored in Pi-hole API version 5. | {% icon "openmoji:check-mark" %} | +| `Verify SSL certificate` | Whether to verify your Pi-hole's certificate (ignored in API version 5). | {% icon "openmoji:check-mark" %} |
43-43: Simplify and streamline instructions.Break the long sentence into clear steps:
-Your App Password can be found by logging into your Pi-Hole and going to _Settings > Web Interface/API_ and then switching from `Basic` to `Expert` mode then clicking **Configure app password** button. +To find your App Password: +1. Log into Pi-hole and go to _Settings > Web Interface/API_. +2. Switch from `Basic` to `Expert` mode. +3. Click the **Configure app password** button.
45-45: Split into two sentences and refine phrasing.Eliminate the comma splice and clarify:
-Versions of Pi-hole before version 6 (released in Feb 2025) use an API Key if the Pi-hole was password protected, this can be found in _Settings > API Tab_ and clicking **Show API token** +For Pi-hole versions prior to version 6 (released Feb 2025), a password-protected Pi-hole uses an API Key. You can find this under _Settings > API Tab_ by clicking **Show API token**.
📜 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/pi_hole.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/pi_hole.markdown
[uncategorized] ~36-~36: Possible missing comma found.
Context: ...ath to the admin page. In the version 6 API this will be ignored. | /admin | | `API...
(AI_HYDRA_LEO_MISSING_COMMA)
[misspelling] ~38-~38: Use “a” instead of ‘an’ if the following word doesn’t start with a vowel sound, e.g. ‘a sentence’, ‘a university’.
Context: ...certificate| Whether your Pi-hole has an Certificate, typically true forhttps`...
(EN_A_VS_AN)
🔇 Additional comments (2)
source/_integrations/pi_hole.markdown (2)
33-34: Port description is clear and correct.The added note on default HTTP/HTTPS ports improves usability.
57-58: Confirm handling of'0'duration value.The doc states
'0'disables indefinitely. Please verify that the backend accepts a string'0'and distinguishes it correctly from a zero-durationtimedelta(0).
Proposed change
Update for changes in V6 API.
Also adds some config info re SSL that wasn't there before
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
nextbranch.Summary by CodeRabbit