fix: use correct description for the trigger_incident attribute (#318)

Author: sorccu

checkly/attribute_trigger_incident.go

@@ -6,7 +6,7 @@ import (
 )
 
 var triggerIncidentAttributeSchema = &schema.Schema{
-	Description: "Set up HTTP basic authentication (username & password).",
+	Description: "Create and resolve an incident based on the alert configuration. Useful for status page automation.",
 	Type:        schema.TypeSet,
 	MaxItems:    1,
 	Optional:    true,

docs/resources/check.md

@@ -222,7 +222,7 @@ resource "checkly_check" "example_check" {
 - `ssl_check_domain` (String) A valid fully qualified domain name (FQDN) to check its SSL certificate.
 - `tags` (Set of String) A list of tags for organizing and filtering checks.
 - `teardown_snippet_id` (Number) An ID reference to a snippet to use in the teardown phase of an API check.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
 
 ### Read-Only

docs/resources/heartbeat.md

@@ -47,7 +47,7 @@ resource "checkly_heartbeat" "example-heartbeat" {
 - `alert_settings` (Block List, Max: 1) (see [below for nested schema](#nestedblock--alert_settings))
 - `muted` (Boolean) Determines if any notifications will be sent out when a check fails/degrades/recovers.
 - `tags` (Set of String) A list of tags for organizing and filtering checks.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
 
 ### Read-Only

docs/resources/heartbeat_monitor.md

@@ -41,7 +41,7 @@ resource "checkly_heartbeat_monitor" "example-heartbeat-monitor" {
 - `alert_settings` (Block List, Max: 1) (see [below for nested schema](#nestedblock--alert_settings))
 - `muted` (Boolean) Determines if any notifications will be sent out when a check fails/degrades/recovers.
 - `tags` (Set of String) A list of tags for organizing and filtering checks.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
 
 ### Read-Only

docs/resources/tcp_check.md

@@ -121,7 +121,7 @@ resource "checkly_tcp_check" "example-tcp-check-2" {
 - `runtime_id` (String) The ID of the runtime to use for this check.
 - `should_fail` (Boolean) Allows to invert the behaviour of when a check is considered to fail.
 - `tags` (Set of String) A list of tags for organizing and filtering checks.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
 
 ### Read-Only

docs/resources/tcp_monitor.md

@@ -115,7 +115,7 @@ resource "checkly_tcp_monitor" "example-tcp-monitor-2" {
 - `runtime_id` (String) The ID of the runtime to use for this check.
 - `should_fail` (Boolean) Allows to invert the behaviour of when a check is considered to fail.
 - `tags` (Set of String) A list of tags for organizing and filtering checks.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
 
 ### Read-Only

docs/resources/url_monitor.md

@@ -61,7 +61,7 @@ resource "checkly_url_monitor" "example-url-monitor" {
 - `run_parallel` (Boolean) Determines whether the monitor should run on all selected locations in parallel or round-robin. (Default `false`).
 - `should_fail` (Boolean) Allows to invert the behaviour of when the monitor is considered to fail. (Default `false`).
 - `tags` (Set of String) A list of tags for organizing and filtering checks and monitors.
-- `trigger_incident` (Block Set, Max: 1) Set up HTTP basic authentication (username & password). (see [below for nested schema](#nestedblock--trigger_incident))
+- `trigger_incident` (Block Set, Max: 1) Create and resolve an incident based on the alert configuration. Useful for status page automation. (see [below for nested schema](#nestedblock--trigger_incident))
 - `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this monitor. (Default `true`).
 
 ### Read-Only