Update html5.markdown to add the silent parameter #36936
Conversation
Update html5 notify docs to include silent attribute solves home-assistant/core#135709
home-assistant
bot
added
has-parent
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes involve updating the HTML5 notification integration documentation to include the Changes
Sequence DiagramsequenceDiagram
participant Client
participant HTML5 Notification System
participant Callback Event
Client->>HTML5 Notification System: Send notification with payload
HTML5 Notification System->>HTML5 Notification System: Process payload
HTML5 Notification System->>Callback Event: Include processed parameters
Callback Event-->>Client: Return event with recognized parameters
The sequence diagram illustrates how the Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
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: 1
🧹 Nitpick comments (1)
source/_integrations/html5.markdown (1)
86-86: Improve sentence clarity while maintaining technical accuracy.The addition of the
silentparameter is correct. However, consider restructuring the sentence for better readability:-Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`, `silent`) will be sent back to you in the [callback events](#automating-notification-events). +The following parameters, if passed in the notify payload, will be sent back to you in the [callback events](#automating-notification-events) as they are not valid for use in the HTML5 notification: `actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`, `silent`.🧰 Tools
🪛 LanguageTool
[grammar] ~86-~86: There seems to be a noun/verb agreement error. Did you mean “isn't” or “wasn't”?
Context: ...hat you pass in the notify payload that aren't valid for use in the HTML5 notification...(SINGULAR_NOUN_AGREEMENT_WHO_DONT)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
source/_integrations/html5.markdown(2 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/html5.markdown
[grammar] ~86-~86: There seems to be a noun/verb agreement error. Did you mean “isn't” or “wasn't”?
Context: ...hat you pass in the notify payload that aren't valid for use in the HTML5 notification...
(SINGULAR_NOUN_AGREEMENT_WHO_DONT)
⏰ 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/html5.markdown (1)
198-198: LGTM! Parameter list is consistent.The addition of the
silentparameter to the excluded parameters list maintains consistency with the earlier documentation.
| @@ -83,7 +83,7 @@ data: | |||
| #### Data | |||
| Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`) will be sent back to you in the [callback events](#automating-notification-events). | |||
| Any parameters that you pass in the notify payload that aren't valid for use in the HTML5 notification (`actions`, `badge`, `body`, `dir`, `icon`, `image`, `lang`, `renotify`, `requireInteraction`, `tag`, `timestamp`, `vibrate`, `priority`, `ttl`, `silent`) will be sent back to you in the [callback events](#automating-notification-events). | |||
There was a problem hiding this comment.
🛠️ Refactor suggestion
Document the purpose and usage of the silent parameter.
While the silent parameter has been added to the lists, its functionality is not documented. Consider adding a section under "Overrides" that explains:
- The purpose of the
silentparameter - Expected values (boolean?)
- Effect on notifications
- Example usage
Example addition:
#### Silent Notifications
You can make a notification silent by setting the `silent` parameter in the data dictionary:
```yaml
title: Front door
message: The front door is open
data:
silent: true
Would you like me to help draft the complete documentation for the `silent` parameter?
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 LanguageTool</summary>
[grammar] ~86-~86: There seems to be a noun/verb agreement error. Did you mean “isn't” or “wasn't”?
Context: ...hat you pass in the notify payload that aren't valid for use in the HTML5 notification...
(SINGULAR_NOUN_AGREEMENT_WHO_DONT)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
home-assistant
bot
removed
awaits-parent
Proposed change
Update html5 notify docs to include silent attribute
solves home-assistant/core#135709
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
silentparameter in payload handling.