Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix automation documentation links #2246

Merged
merged 1 commit into from
Aug 20, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions src/language-service/src/schemas/integrations/core/automation.ts
Original file line number Diff line number Diff line change
Expand Up @@ -50,27 +50,27 @@ interface BaseItem {
/**
* When you create a new automation, it will be enabled unless you explicitly add initial_state: false to it or turn it off manually via UI/another automation/developer tools.
* In case automations need to be always enabled or disabled when Home Assistant starts, then you can set the initial_state in your automations. Otherwise, the previous state will be restored.
* https://www.home-assistant.io/docs/automation/#automation-initial-state
* https://www.home-assistant.io/docs/automation/yaml/#initial_state
*/
initial_state?: boolean;

/**
* For both queued and parallel modes, configuration option max controls the maximum number of runs that can be executing and/or queued up at a time. The default is 10.
* https://www.home-assistant.io/docs/automation/#automation-modes
* https://www.home-assistant.io/docs/automation/modes/
*
* @minimum 2
*/
max?: number;

/**
* The automation’s mode configuration option controls what happens when the automation is triggered while the actions are still running from a previous trigger.
* https://www.home-assistant.io/docs/automation/#automation-modes
* https://www.home-assistant.io/docs/automation/modes/
*/
mode?: Mode;

/**
* When `max` is exceeded (which is effectively 1 for `single` mode) a log message will be emitted to indicate this has happened. This controls the severity level of that log message
* https://www.home-assistant.io/docs/automation/#automation-modes
* https://www.home-assistant.io/docs/automation/modes/
*/
max_exceeded?:
| "silent"
Expand All @@ -97,21 +97,21 @@ interface BaseItem {

/**
* Variables that will be available inside your templates and conditions.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
variables?: Data;

/**
* Conditions are optional tests that can limit an automation rule to only work in your specific use cases. A condition will test against the current state of the system. This includes the current time, devices, people and other things like the sun.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
condition?: Condition | Condition[] | DynamicTemplate | IncludeList;
}

export interface AutomationItem extends BaseItem {
/**
* Triggers describe events that should trigger the automation rule.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
trigger: Trigger | Trigger[] | IncludeList;

Expand All @@ -123,7 +123,7 @@ export interface AutomationItem extends BaseItem {

/**
* The action(s) which will be performed when a rule is triggered and all conditions are met. For example, it can turn a light on, set the temperature on your thermostat or activate a scene.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
action: Action | Action[] | IncludeList;
}
Expand All @@ -136,13 +136,13 @@ interface BlueprintItem extends BaseItem {

/**
* Triggers describe events that should trigger the automation rule.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
trigger?: Trigger | Trigger[] | IncludeList;

/**
* The action(s) which will be performed when a rule is triggered and all conditions are met. For example, it can turn a light on, set the temperature on your thermostat or activate a scene.
* https://www.home-assistant.io/docs/automation/#automation-basics
* https://www.home-assistant.io/docs/automation/basics/
*/
action?: Action | Action[] | IncludeList;
}