Skip to content

Commit

Permalink
update docs (#290)
Browse files Browse the repository at this point in the history
  • Loading branch information
benben authored May 30, 2024
1 parent a284989 commit dc0dd8d
Show file tree
Hide file tree
Showing 3 changed files with 15 additions and 15 deletions.
10 changes: 5 additions & 5 deletions docs/resources/check.md
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,7 @@ resource "checkly_check" "example_check" {
### Optional

- `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))
- `alert_settings` (Block List, 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.
- `environment_variable` (Block List) Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden. These are only relevant for browser checks. Use global environment variables whenever possible. (see [below for nested schema](#nestedblock--environment_variable))
Expand Down Expand Up @@ -243,11 +243,11 @@ Required:
Optional:

- `escalation_type` (String) Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
- `parallel_run_failure_threshold` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `parallel_run_failure_threshold` (Block List) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block List) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `ssl_certificates` (Block Set, Deprecated) (see [below for nested schema](#nestedblock--alert_settings--ssl_certificates))
- `time_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))
- `time_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))

<a id="nestedblock--alert_settings--parallel_run_failure_threshold"></a>
### Nested Schema for `alert_settings.parallel_run_failure_threshold`
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/check_group.md
Original file line number Diff line number Diff line change
Expand Up @@ -146,7 +146,7 @@ resource "checkly_check_group" "test_group1" {
### Optional

- `alert_channel_subscription` (Block List) (see [below for nested schema](#nestedblock--alert_channel_subscription))
- `alert_settings` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--alert_settings))
- `alert_settings` (Block List, Max: 1) (see [below for nested schema](#nestedblock--alert_settings))
- `api_check_defaults` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--api_check_defaults))
- `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.
- `environment_variable` (Block List) Key/value pairs for setting environment variables during check execution, add locked = true to keep value hidden. These are only relevant for browser checks. Use global environment variables whenever possible. (see [below for nested schema](#nestedblock--environment_variable))
Expand Down Expand Up @@ -183,11 +183,11 @@ Required:
Optional:

- `escalation_type` (String) Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
- `parallel_run_failure_threshold` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `parallel_run_failure_threshold` (Block List) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block List) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `ssl_certificates` (Block Set, Deprecated) (see [below for nested schema](#nestedblock--alert_settings--ssl_certificates))
- `time_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))
- `time_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))

<a id="nestedblock--alert_settings--parallel_run_failure_threshold"></a>
### Nested Schema for `alert_settings.parallel_run_failure_threshold`
Expand Down
10 changes: 5 additions & 5 deletions docs/resources/heartbeat.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ Heartbeats allows you to monitor your cron jobs and set up alerting, so you get
### Optional

- `alert_channel_subscription` (Block List) (see [below for nested schema](#nestedblock--alert_channel_subscription))
- `alert_settings` (Block Set, Max: 1) (see [below for nested schema](#nestedblock--alert_settings))
- `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.
- `use_global_alert_settings` (Boolean) When true, the account level alert settings will be used, not the alert setting defined on this check.
Expand Down Expand Up @@ -63,11 +63,11 @@ Required:
Optional:

- `escalation_type` (String) Determines what type of escalation to use. Possible values are `RUN_BASED` or `TIME_BASED`.
- `parallel_run_failure_threshold` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `parallel_run_failure_threshold` (Block List) (see [below for nested schema](#nestedblock--alert_settings--parallel_run_failure_threshold))
- `reminders` (Block List) (see [below for nested schema](#nestedblock--alert_settings--reminders))
- `run_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--run_based_escalation))
- `ssl_certificates` (Block Set, Deprecated) (see [below for nested schema](#nestedblock--alert_settings--ssl_certificates))
- `time_based_escalation` (Block Set) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))
- `time_based_escalation` (Block List) (see [below for nested schema](#nestedblock--alert_settings--time_based_escalation))

<a id="nestedblock--alert_settings--parallel_run_failure_threshold"></a>
### Nested Schema for `alert_settings.parallel_run_failure_threshold`
Expand Down

0 comments on commit dc0dd8d

Please sign in to comment.