Add description for Habitica get_tasks action. #35210
Conversation
home-assistant
bot
added
Hacktoberfest
✅ Deploy Preview for home-assistant-docs ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
📝 WalkthroughWalkthroughThe changes introduce a new action, Changes
Sequence Diagram(s)sequenceDiagram
participant User
participant HabiticaIntegration
participant HabiticaAPI
User->>HabiticaIntegration: Request to get tasks
HabiticaIntegration->>HabiticaAPI: Call get_tasks with filters
HabiticaAPI-->>HabiticaIntegration: Return task list
HabiticaIntegration-->>User: Provide filtered task list
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: 0
🧹 Outside diff range and nitpick comments (1)
source/_integrations/habitica.markdown (1)
89-97: LGTM! New action documentation added successfully.The new section for the
habitica.get_tasksaction is well-structured and provides clear information about its purpose and filtering options.Minor grammatical correction needed.
In the list of task types, "todo" should be hyphenated to "to-do" for consistency with the rest of the document.
Apply this change:
-Task types [habit, daily, todo, reward] +Task types [habit, daily, to-do, reward]Consider adding data attributes information.
To improve completeness, consider adding information about the required and optional data attributes for this action, similar to the
habitica.cast_skillaction documentation above.Would you like assistance in drafting a data attributes table for this action?
🧰 Tools
🪛 LanguageTool
[grammar] ~93-~93: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...done on: - Task types [habit, daily, todo, reward] - Task priorities [trivial, ea...(TO_DO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_integrations/habitica.markdown (1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/habitica.markdown
[grammar] ~93-~93: It appears that a hyphen is missing in the noun “to-do” (= task) or did you mean the verb “to do”?
Context: ...done on: - Task types [habit, daily, todo, reward] - Task priorities [trivial, ea...(TO_DO_HYPHEN)
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (1)
source/_integrations/habitica.markdown (1)
89-100: LGTM! Consider a minor formatting adjustment for consistency.The new
habitica.get_tasksaction is well-documented and provides valuable functionality for retrieving tasks with various filtering options. The description and table are clear and informative.For consistency with other tables in the document, consider wrapping the data attribute names in the table with backticks. For example:
| Data attribute | Optional | Description | | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | | `config_entry` | no | Choose the Habitica character to retrieve tasks from. | | `type` | yes | Filter tasks by type. | | `priority` | yes | Filter tasks by difficulty. | | `task` | yes | Select specific tasks by matching their name (or task ID). | | `tag` | yes | Filter tasks that have one or more of the selected tags. | | `keyword` | yes | Filter tasks by keyword, searching across titles, notes, and checklists. |
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
- source/_integrations/habitica.markdown (1 hunks)
🧰 Additional context used
🔇 Additional comments (1)
source/_integrations/habitica.markdown (1)
Line range hint
1-100: Overall changes look good and align with PR objectives.The addition of the
habitica.get_tasksaction enhances the Habitica integration by allowing users to retrieve tasks with various filtering options. This new functionality is well-documented and seamlessly integrated into the existing markdown file.The changes align with the PR objectives and the AI-generated summary, providing a clear description of the new
get_tasksaction. The rest of the file remains unchanged, maintaining consistency with the existing documentation.
| ### Action `habitica.get_tasks` | ||
|
|
||
| Fetch tasks from your Habitica account, with optional filters to narrow down the results for more precise task retrieval. | ||
|
|
||
| | Data attribute | Optional | Description | | ||
| | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | | ||
| | config_entry | no | Choose the Habitica character to retrieve tasks from. | | ||
| | type | yes | Filter tasks by type. | | ||
| | priority | yes | Filter tasks by difficulty. | | ||
| | task | yes | Select specific tasks by matching their name (or task ID). | | ||
| | tag | yes | Filter tasks that have one or more of the selected tags. | | ||
| | keyword | yes | Filter tasks by keyword, searching across titles, notes, and checklists. | | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Documentation needs additional details for better usability.
While the basic structure is good, the documentation would be more helpful with the following additions:
-
Add possible values for the filters:
- What are the valid task types? (e.g., "habits", "dailies", "todos")
- What are the valid priority levels?
- What format should the tag names be in?
-
Include example usage:
- Add a basic example of fetching all tasks
- Add an example with filters
- Consider adding an automation example like the other sections
-
Document the return format:
- What structure/format is the returned data in?
- What fields are included for each task?
Here's a suggested expansion of the documentation:
### Action `habitica.get_tasks`
Fetch tasks from your Habitica account, with optional filters to narrow down the results for more precise task retrieval.
| Data attribute | Optional | Description |
| -------------- | -------- | -------------------------------------------------------------------------------------------------------- |
| config_entry | no | Choose the Habitica character to retrieve tasks from. |
-| type | yes | Filter tasks by type. |
+| type | yes | Filter tasks by type. Valid types: "habits", "dailies", "todos", "rewards". |
-| priority | yes | Filter tasks by difficulty. |
+| priority | yes | Filter tasks by difficulty. Valid values: 0.1 (Trivial), 1 (Easy), 1.5 (Medium), 2 (Hard). |
| task | yes | Select specific tasks by matching their name (or task ID). |
| tag | yes | Filter tasks that have one or more of the selected tags. |
| keyword | yes | Filter tasks by keyword, searching across titles, notes, and checklists. |
+
+#### Example Usage
+
+Basic usage to fetch all tasks:
+```yaml
+service: habitica.get_tasks
+data:
+ config_entry: your_config_entry
+```
+
+Fetch only high-priority daily tasks:
+```yaml
+service: habitica.get_tasks
+data:
+ config_entry: your_config_entry
+ type: dailies
+ priority: 2
+```
+
+#### Response Format
+
+The action returns a list of tasks, where each task contains:
+- `id`: Unique task identifier
+- `text`: Task title/description
+- `type`: Task type (habit/daily/todo/reward)
+- `priority`: Task difficulty
+[Additional fields to be documented...]
tr4nt0r
force-pushed
the
habitica_get_tasks
branch
from
42c06b9
to
df8f697
Compare
catsmanac
changed the title
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (1)
source/_integrations/habitica.markdown (1)
217-217: Fix hyphenation in task types.For consistency with the rest of the documentation, "todos" should be hyphenated as "to-dos".
🧰 Tools
🪛 LanguageTool
[grammar] ~217-~217: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...(TO_DO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/habitica.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/habitica.markdown
[grammar] ~217-~217: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...
(TO_DO_HYPHEN)
Co-authored-by: Manu <4445816+tr4nt0r@users.noreply.github.com>
Co-authored-by: Manu <4445816+tr4nt0r@users.noreply.github.com>
tr4nt0r
force-pushed
the
habitica_get_tasks
branch
from
df8f697
to
ec5a84f
Compare
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Outside diff range and nitpick comments (2)
source/_integrations/habitica.markdown (2)
234-234: Fix hyphenation in task type.For consistency with the rest of the documentation, "todos" should be hyphenated as "to-dos".
-| type | yes | Filter tasks by type. Valid types: "habits", "dailies", "todos", "rewards". | +| type | yes | Filter tasks by type. Valid types: "habits", "dailies", "to-dos", "rewards". |🧰 Tools
🪛 LanguageTool
[grammar] ~234-~234: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...(TO_DO_HYPHEN)
231-238: Fix table formatting inconsistencies.The table has inconsistent spacing and alignment. Some lines have extra spaces that should be removed.
-| Data attribute | Optional | Description | -| -------------- | -------- | -------------------------------------------------------------------------------------------------------- | -| config_entry | no | Choose the Habitica character to retrieve tasks from. | -| type | yes | Filter tasks by type. Valid types: "habits", "dailies", "to-dos", "rewards". | -| priority | yes | Filter tasks by difficulty. Valid values: "trivial", "easy", "medium", "hard". | -| task | yes | Select specific tasks by matching their name (or task ID). | -| tag | yes | Filter tasks that have one or more of the selected tags. | -| keyword | yes | Filter tasks by keyword, searching across titles, notes, and checklists. | +| Data attribute | Optional | Description | +| -------------- | -------- | ----------- | +| config_entry | no | Choose the Habitica character to retrieve tasks from. | +| type | yes | Filter tasks by type. Valid types: "habits", "dailies", "to-dos", "rewards". | +| priority | yes | Filter tasks by difficulty. Valid values: "trivial", "easy", "medium", "hard". | +| task | yes | Select specific tasks by matching their name (or task ID). | +| tag | yes | Filter tasks that have one or more of the selected tags. | +| keyword | yes | Filter tasks by keyword, searching across titles, notes, and checklists. |🧰 Tools
🪛 LanguageTool
[grammar] ~234-~234: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...(TO_DO_HYPHEN)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
📒 Files selected for processing (1)
source/_integrations/habitica.markdown(1 hunks)
🧰 Additional context used
🪛 LanguageTool
source/_integrations/habitica.markdown
[grammar] ~234-~234: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...
(TO_DO_HYPHEN)
| ### Action `habitica.get_tasks` | ||
|
|
||
| Fetch tasks from your Habitica account, with optional filters to narrow down the results for more precise task retrieval. | ||
|
|
||
| | Data attribute | Optional | Description | | ||
| | -------------- | -------- | -------------------------------------------------------------------------------------------------------- | | ||
| | config_entry | no | Choose the Habitica character to retrieve tasks from. | | ||
| | type | yes | Filter tasks by type. Valid types: "habits", "dailies", "todos", "rewards". | | ||
| | priority | yes | Filter tasks by difficulty. Valid values: "trivial", "easy", "medium", "hard". | | ||
| | task | yes | Select specific tasks by matching their name (or task ID). | | ||
| | tag | yes | Filter tasks that have one or more of the selected tags. | | ||
| | keyword | yes | Filter tasks by keyword, searching across titles, notes, and checklists. | | ||
|
|
There was a problem hiding this comment.
🛠️ Refactor suggestion
Add examples and return format documentation.
Following the pattern of other actions in the documentation, this section would benefit from examples and return format details.
Add the following sections after the data attributes table:
#### Examples
Fetch all tasks:
```yaml
service: habitica.get_tasks
data:
config_entry: your_config_entryFetch high-priority dailies:
service: habitica.get_tasks
data:
config_entry: your_config_entry
type: dailies
priority: hardFetch tasks with specific tag and keyword:
service: habitica.get_tasks
data:
config_entry: your_config_entry
tag: work
keyword: urgentReturn Format
The action returns a list of tasks, where each task contains:
id: Unique task identifiertext: Task titletype: Task type (habit/daily/to-do/reward)priority: Task difficultynotes: Additional task notes (if any)checklist: List of checklist items (if any)tags: List of associated tagsdue: Due date (for to-dos, if set)frequency: Repeat frequency (for dailies)streak: Current completion streak
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 LanguageTool</summary>
[grammar] ~234-~234: It appears that a hyphen is missing in the plural noun “to-dos”?
Context: ...pe. Valid types: "habits", "dailies", "todos", "rewards". ...
(TO_DO_HYPHEN)
</details>
</details>
<!-- This is an auto-generated comment by CodeRabbit -->
Proposed change
Add description of a get_tasks action which is being added to the Habitica integration
Type of change
currentbranch).currentbranch).nextbranch).nextbranch).Additional information
Checklist
currentbranch.nextbranch.Summary by CodeRabbit
New Features
Documentation