Skip to content

Commit

Permalink
Add "summary" besides "name" to clarify description (#37511)
Browse files Browse the repository at this point in the history 
Co-authored-by: Abílio Costa <[email protected]>
  • Loading branch information
@NoRi2909 @abmantis
NoRi2909 and abmantis authored Feb 17, 2025
1 parent 9e90c68 commit 70723aa
Showing 1 changed file with 9 additions and 9 deletions.
18 changes: 9 additions & 9 deletions source/_integrations/todo.markdown
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

| Data attribute | Optional | Description | Example |
| -------------- | -------- | ---------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | the name 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_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. |
| Data attribute | Optional | Description | Example |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `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_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. |

Only one of `due_date` or `due_datetime` may be specified.

Expand All @@ -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 |
| -------------- | -------- | ----------------------------------------------------------------- | ------------------------------------------------------------ |
| `item` | no | The name of the to-do Item to update. | Submit income tax return |
| `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` |
| `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 |
| `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_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. |
Expand Down

0 comments on commit 70723aa

Please sign in to comment.