Skip to content

Commit 5d1b79a

Browse files
committed
docs(constructs): add description property to check/monitor config tables [TREE-735]
1 parent beaca0c commit 5d1b79a

7 files changed

Lines changed: 7 additions & 0 deletions

File tree

constructs/api-check.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ The API Check configuration consists of specific API Check options and inherited
9090
| Property | Type | Required | Default | Description |
9191
|----------|------|----------|---------|-------------|
9292
| `name` | `string` || - | Friendly name for your check |
93+
| `description` | `string` || `null` | A description of the check. Supports markdown. Max 500 characters |
9394
| `activated` | `boolean` || `true` | Whether the check is enabled |
9495
| `alertChannels` | `AlertChannel[]` || `[]` | Array of AlertChannel objects for notifications |
9596
| `alertEscalationPolicy` | `AlertEscalationPolicy` || - | Advanced alert settings |

constructs/browser-check.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,7 @@ The Browser Check configuration consists of specific Browser Check options and i
7676
| Property | Type | Required | Default | Description |
7777
|----------|------|----------|---------|-------------|
7878
| `name` | `string` || - | Friendly name for your check |
79+
| `description` | `string` || `null` | A description of the check. Supports markdown. Max 500 characters |
7980
| `activated` | `boolean` || `true` | Whether the check is enabled |
8081
| `alertChannels` | `AlertChannel[]` || `[]` | Array of AlertChannel objects for notifications |
8182
| `alertEscalationPolicy` | `AlertEscalationPolicy` || - | Advanced alert settings |

constructs/heartbeat-monitor.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ The Heartbeat Monitoring configuration consists of specific heartbeat monitoring
7373
| Property | Type | Required | Default | Description |
7474
|----------|------|----------|---------|-------------|
7575
| `name` | `string` || - | Friendly name for your monitor |
76+
| `description` | `string` || `null` | A description of the monitor. Supports markdown. Max 500 characters |
7677
| `activated` | `boolean` || `true` | Whether the monitor is enabled |
7778
| `muted` | `boolean` || `false` | Whether alert notifications are muted |
7879
| `alertChannels` | `AlertChannel[]` || `[]` | Array of AlertChannel objects for notifications |

constructs/multistep-check.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@ new MultiStepCheck("complex-multistep-check", {
7474
| Property | Type | Required | Default | Description |
7575
|----------|------|----------|---------|-------------|
7676
| `name` | `string` || - | Friendly name for your check |
77+
| `description` | `string` || `null` | A description of the check. Supports markdown. Max 500 characters |
7778
| `activated` | `boolean` || `true` | Whether the check is enabled |
7879
| `alertChannels` | `AlertChannel[]` || `[]` | Array of AlertChannel objects for notifications |
7980
| `alertEscalationPolicy` | `AlertEscalationPolicy` || - | Advanced alert settings |

constructs/playwright-check.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ The Playwright Check Suite configuration consists of specific Playwright Check S
7373
| Property | Type | Required | Default | Description |
7474
|----------|------|----------|---------|-------------|
7575
| `name` | `string` || - | Friendly name for your check |
76+
| `description` | `string` || `null` | A description of the check. Supports markdown. Max 500 characters |
7677
| `activated` | `boolean` || `true` | Whether the check is enabled |
7778
| `alertChannels` | `AlertChannel[]` || `[]` | Array of AlertChannel objects for notifications |
7879
| `alertEscalationPolicy` | `AlertEscalationPolicy` || - | Advanced alert settings |

detect/synthetic-monitoring/playwright-checks/configuration.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ Learn more about [best practices to organize and structure your Playwright tests
9090
A Playwright Check Suite inherits multiple properties from [the abstract `Check` class](/cli/constructs-reference/#check):
9191

9292
- `name`
93+
- `description`
9394
- `activated`
9495
- `muted`
9596
- `locations`

snippets/general-monitor-options-table.mdx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
| Property | Type | Required | Default | Description |
22
|----------|------|----------|---------|-------------|
33
| `name` | `string` || - | Friendly name for your monitor |
4+
| `description` | `string` || `null` | A description of the monitor. Supports markdown. Max 500 characters |
45
| `activated` | `boolean` || `true` | Whether the monitor is enabled |
56
| `alertChannels` | `Array<AlertChannel \| AlertChannelRef>` || `[]` | Array of AlertChannel objects for notifications |
67
| `alertEscalationPolicy` | `AlertEscalationPolicy` || - | Advanced alert escalation settings |

0 commit comments

Comments
 (0)