jeans/home-assistant.io
jeans/home-assistant.io
1
0
Fork 0
mirror of https://github.com/home-assistant/home-assistant.io.git synced 2025-07-24 17:57:14 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add "summary" besides "name" to clarify description (#37511)

Browse Source 
Co-authored-by: Abílio Costa <abmantis@users.noreply.github.com>
This commit is contained in:
Norbert Rittel 2025-02-17 13:53:19 +01:00 committed by GitHub
parent 9e90c68f8d
commit 70723aa214
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
source/_integrations/todo.markdown
View File

@ -80,12 +80,12 @@ data:
Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields: Add a new to-do item. A to-do list `target` is selected with a [Target Selector](/docs/blueprint/selectors/#target-selector) and the `data` payload supports the following fields:
| Data attribute | Optional | Description | Example | | Data attribute | Optional | Description | Example |
| -------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ | | -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | the name of the to-do Item. | Submit income tax return | | `item` | no | The name/summary of the to-do item. | Submit income tax return |
| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | | `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 | | `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `description` | yes | A more complete description than the one provided by the summary | Collect all necessary documents and submit the final return. | | `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |
Only one of `due_date` or `due_datetime` may be specified. Only one of `due_date` or `due_datetime` may be specified.
@ -107,9 +107,9 @@ Update a to-do item. A to-do list `target` is selected with a [Target Selector](
| Data attribute | Optional | Description | Example | | Data attribute | Optional | Description | Example |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ | | -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | The name of the to-do Item to update. | Submit income tax return | | `item` | no | The name/summary of the to-do item to update. | Submit income tax return |
| `rename` | yes | The new name of the to-do Item. | Something else | | `rename` | yes | The new name of the to-do item. | Something else |
| `status` | yes | The overall status of the To-do Item. | `needs_action` or `completed` | | `status` | yes | The overall status of the to-do item. | `needs_action` or `completed` |
| `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 | | `due_date` | yes | The date the to-do item is expected to be completed. | 2024-04-10 |
| `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 | | `due_datetime` | yes | The date and time the to-do item is expected to be completed. | 2024-04-10 23:00:00 |
| `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. | | `description` | yes | A more complete description than the one provided by the summary. | Collect all necessary documents and submit the final return. |