From 6c91ede13983257feb813c36ab98d55a0f4525a7 Mon Sep 17 00:00:00 2001 From: Antoine Coutellier Date: Tue, 30 Jan 2024 11:48:30 +0100 Subject: [PATCH] chore: add description for alert channel subscriptions (#283) * chore: add description for alert channel subscriptions * chore: add docs * Update checkly/resource_check.go Co-authored-by: Manel Fourati * Update docs/resources/check.md Co-authored-by: Manel Fourati --------- Co-authored-by: Manel Fourati --- checkly/resource_check.go | 7 ++++--- docs/resources/check.md | 2 +- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/checkly/resource_check.go b/checkly/resource_check.go index 40af8e8..34805f3 100644 --- a/checkly/resource_check.go +++ b/checkly/resource_check.go @@ -155,7 +155,7 @@ func resourceCheck() *schema.Resource { Type: schema.TypeBool, Optional: true, Description: "Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.", - Deprecated: "The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.", + Deprecated: "The property `double_check` is deprecated and will be removed in a future version. To enable retries for failed check runs, use the `retry_strategy` property instead.", }, "tags": { Type: schema.TypeSet, @@ -203,8 +203,9 @@ func resourceCheck() *schema.Resource { Description: "The id of the runtime to use for this check.", }, "alert_channel_subscription": { - Type: schema.TypeList, - Optional: true, + Type: schema.TypeList, + Optional: true, + Description: "An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it.", Elem: &schema.Resource{ Schema: map[string]*schema.Schema{ "channel_id": { diff --git a/docs/resources/check.md b/docs/resources/check.md index 29d12e9..f7c3b3c 100644 --- a/docs/resources/check.md +++ b/docs/resources/check.md @@ -196,7 +196,7 @@ resource "checkly_check" "example_check" { ### Optional -- `alert_channel_subscription` (Block List) (see [below for nested schema](#nestedblock--alert_channel_subscription)) +- `alert_channel_subscription` (Block List) An array of channel IDs and whether they're activated or not. If you don't set at least one alert subscription for your check, we won't be able to alert you in case something goes wrong with it. (see [below for nested schema](#nestedblock--alert_channel_subscription)) - `alert_settings` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--alert_settings)) - `degraded_response_time` (Number) The response time in milliseconds starting from which a check should be considered degraded. Possible values are between 0 and 30000. (Default `15000`). - `double_check` (Boolean, Deprecated) Setting this to `true` will trigger a retry when a check fails from the failing region and another, randomly selected region before marking the check as failed.