mirror of
https://github.com/home-assistant/developers.home-assistant.git
synced 2025-11-15 05:50:18 +00:00
Add integration quality scale docs (#2457)
Co-authored-by: Martin Hjelmare <marhje52@gmail.com> Co-authored-by: Franck Nijhof <frenck@frenck.nl> Co-authored-by: c0ffeeca7 <38767475+c0ffeeca7@users.noreply.github.com>
This commit is contained in:
committed by
GitHub
parent
a1f286224a
commit
cf52c30bc0
27
docs/core/integration-quality-scale/rules/docs-actions.md
Normal file
27
docs/core/integration-quality-scale/rules/docs-actions.md
Normal file
@@ -0,0 +1,27 @@
|
||||
---
|
||||
title: "The documentation describes the provided service actions that can be used"
|
||||
---
|
||||
|
||||
## Reasoning
|
||||
|
||||
Integrations can register service actions to provide functionality that is not possible with standard entities.
|
||||
These service actions can be harder to use than the standard service actions, so we want to make sure that the documentation describes both what they do, and what the parameters are.
|
||||
|
||||
## Example implementation
|
||||
|
||||
```markdown showLineNumbers
|
||||
## Actions
|
||||
|
||||
The integration provides the following actions.
|
||||
|
||||
### Action: Get schedule
|
||||
|
||||
The `my_integration.get_schedule` service is used to fetch a schedule from the integration.
|
||||
|
||||
| Data attribute | Optional | Description |
|
||||
|------------------------|----------|------------------------------------------------------|
|
||||
| `config_entry_id` | No | The ID of the config entry to get the schedule from. |
|
||||
```
|
||||
|
||||
## Exceptions
|
||||
|
||||
Reference in New Issue
Block a user