Merge pull request #250 from checkly/paula/docs-check-description-cli

docs(constructs): add description property to CLI construct tables [TREE-735][show]

Author: pmallol

constructs/api-check.mdx

@@ -28,6 +28,7 @@ import { ApiCheck } from "checkly/constructs"
 
 new ApiCheck("hello-api-1", {
   name: "Hello API Check",
+  description: "Verifies the `/hello` endpoint returns a **successful** response.",
   request: {
     method: "GET",
     url: "https://api.checklyhq.com/hello",
@@ -40,6 +41,7 @@ import { ApiCheck, AssertionBuilder, Frequency } from "checkly/constructs"
 
 new ApiCheck("advanced-api-check", {
   name: "Advanced API Check",
+  description: "User creation succeeds (201) with valid ID.",
   activated: true,
   frequency: Frequency.EVERY_5M,
   locations: ["us-east-1", "eu-west-1"],
@@ -90,6 +92,7 @@ The API Check configuration consists of specific API Check options and inherited
 | Property | Type | Required | Default | Description |
 |----------|------|----------|---------|-------------|
 | `name` | `string` | ✅ | - | Friendly name for your check |
+| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters |
 | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled |
 | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications |
 | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings |

constructs/browser-check.mdx

@@ -28,6 +28,7 @@ import * as path from "path"
 
 new BrowserCheck("browser-check-1", {
   name: "Browser check #1",
+  description: "Loads the **home page** and asserts key elements are visible.",
   frequency: Frequency.EVERY_10M,
   locations: ["us-east-1", "eu-west-1"],
   code: {
@@ -42,6 +43,7 @@ import * as path from "path"
 
 new BrowserCheck("advanced-browser-check", {
   name: "Advanced Browser Check",
+  description: "Loads the **home page** and asserts key elements are visible.",
   activated: true,
   frequency: Frequency.EVERY_5M,
   locations: ["us-east-1", "eu-west-1"],
@@ -76,6 +78,7 @@ The Browser Check configuration consists of specific Browser Check options and i
 | Property | Type | Required | Default | Description |
 |----------|------|----------|---------|-------------|
 | `name` | `string` | ✅ | - | Friendly name for your check |
+| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters |
 | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled |
 | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications |
 | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings |

constructs/dns-monitor.mdx

@@ -29,6 +29,7 @@ import { Frequency, DnsAssertionBuilder, DnsMonitor } from "checkly/constructs"
 
 new DnsMonitor("dns-monitor", {
   name: "DNS A Record Monitor",
+  description: "Asserts `example.com` A record resolves to the **expected IP**.",
   activated: true,
   maxResponseTime: 1000,
   degradedResponseTime: 500,
@@ -49,6 +50,7 @@ import { Frequency, DnsAssertionBuilder, DnsMonitor } from "checkly/constructs"
 
 new DnsMonitor("advanced-dns-monitor", {
   name: "Advanced DNS Monitor",
+  description: "Asserts `api.example.com` A record resolves to the **expected IP**.",
   activated: true,
   frequency: Frequency.EVERY_5M,
   locations: ["us-east-1", "eu-central-1"],

constructs/heartbeat-monitor.mdx

@@ -28,6 +28,7 @@ import { HeartbeatMonitor } from "checkly/constructs"
 
 new HeartbeatMonitor("daily-backup-heartbeat", {
   name: "Daily Backup Job",
+  description: "Expects a ping every **24h** from the nightly DB backup cron.",
   period: 1,
   periodUnit: "days",
   grace: 2,
@@ -40,6 +41,7 @@ import { HeartbeatMonitor } from "checkly/constructs"
 
 new HeartbeatMonitor("newsletter-heartbeat", {
   name: "Weekly Newsletter Job",
+  description: "Weekly newsletter job completes every 7 days.",
   activated: true,
   muted: false,
   period: 7,
@@ -73,6 +75,7 @@ The Heartbeat Monitoring configuration consists of specific heartbeat monitoring
 | Property | Type | Required | Default | Description |
 |----------|------|----------|---------|-------------|
 | `name` | `string` | ✅ | - | Friendly name for your monitor |
+| `description` | `string` | ❌ | `null` | A description of the monitor. Supports markdown. Max 500 characters |
 | `activated` | `boolean` | ❌ | `true` | Whether the monitor is enabled |
 | `muted` | `boolean` | ❌ | `false` | Whether alert notifications are muted |
 | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications |

constructs/icmp-monitor.mdx

@@ -29,6 +29,7 @@ import { Frequency, IcmpMonitor } from "checkly/constructs"
 
 new IcmpMonitor('icmp-welcome', {
   name: 'Welcome Site Reachability',
+  description: "Pings `welcome.checklyhq.com` to verify **host reachability**.",
   frequency: Frequency.EVERY_1M,
   request: {
     hostname: 'welcome.checklyhq.com',
@@ -43,6 +44,7 @@ import { Frequency, IcmpAssertionBuilder, IcmpMonitor } from "checkly/constructs
 
 new IcmpMonitor('cloudflare-dns-icmp', {
   name: 'Cloudflare DNS ICMP Monitor',
+  description: "Cloudflare DNS reachability and latency check.",
   activated: true,
   frequency: Frequency.EVERY_1M,
   maxPacketLossThreshold: 20, // percentage

constructs/multistep-check.mdx

@@ -28,6 +28,7 @@ import * as path from "path"
 
 new MultiStepCheck("multistep-check-1", {
   name: "Multistep Check #1",
+  description: "Validates user signup and login flow.",
   locations: ["us-east-1", "eu-west-1"],
   code: {
     entrypoint: path.join(__dirname, "multi-step.spec.ts"),
@@ -41,6 +42,7 @@ import * as path from "path"
 
 new MultiStepCheck("complex-multistep-check", {
   name: "Complex User Journey",
+  description: "Validates user signup and login flow.",
   activated: true,
   runtimeId: "2025.04",
   frequency: Frequency.EVERY_15M,
@@ -74,6 +76,7 @@ new MultiStepCheck("complex-multistep-check", {
 | Property | Type | Required | Default | Description |
 |----------|------|----------|---------|-------------|
 | `name` | `string` | ✅ | - | Friendly name for your check |
+| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters |
 | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled |
 | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications |
 | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings |

constructs/playwright-check.mdx

@@ -30,6 +30,7 @@ import { PlaywrightCheck } from "checkly/constructs"
 
 new PlaywrightCheck("critical-e2e-monitor", {
   name: "Critical E2E Monitor",
+  description: "Runs the **critical path** e2e suite against production.",
   playwrightConfigPath: "./playwright.config.ts",
 })
 ```
@@ -39,6 +40,7 @@ import { PlaywrightCheck } from "checkly/constructs"
 
 new PlaywrightCheck("critical-e2e-monitor", {
   name: "Critical E2E Monitor",
+  description: "Runs the **critical path** e2e suite against production.",
   include: ['.npmrc','test-files/**'],
   playwrightConfigPath: "./playwright.config.ts",
   installCommand: "npm ci",
@@ -73,6 +75,7 @@ The Playwright Check Suite configuration consists of specific Playwright Check S
 | Property | Type | Required | Default | Description |
 |----------|------|----------|---------|-------------|
 | `name` | `string` | ✅ | - | Friendly name for your check |
+| `description` | `string` | ❌ | `null` | A description of the check. Supports markdown. Max 500 characters |
 | `activated` | `boolean` | ❌ | `true` | Whether the check is enabled |
 | `alertChannels` | `AlertChannel[]` | ❌ | `[]` | Array of AlertChannel objects for notifications |
 | `alertEscalationPolicy` | `AlertEscalationPolicy` | ❌ | - | Advanced alert settings |

constructs/tcp-monitor.mdx

@@ -30,6 +30,7 @@ import { TcpAssertionBuilder, TcpMonitor } from "checkly/constructs"
 
 new TcpMonitor("database-tcp-1", {
   name: "Database Connection Check",
+  description: "Verifies **PostgreSQL** on `db.example.com:5432` accepts connections.",
   activated: true,
   maxResponseTime: 5000,
   degradedResponseTime: 2000,
@@ -47,6 +48,7 @@ import { Frequency, TcpAssertionBuilder, TcpMonitor } from "checkly/constructs"
 
 new TcpMonitor("redis-tcp-1", {
   name: "Redis Service Check",
+  description: "Verifies **Redis service** is reachable and responsive.",
   activated: true,
   frequency: Frequency.EVERY_5M,
   locations: ["us-east-1", "eu-west-1"],

constructs/url-monitor.mdx

@@ -30,6 +30,7 @@ import { Frequency, UrlAssertionBuilder, UrlMonitor } from "checkly/constructs"
 
 new UrlMonitor("url-monitor", {
   name: "Url Monitor",
+  description: "[httpbin.org/get](https://httpbin.org/get) should return **200** status code.",
   activated: true,
   maxResponseTime: 10000,
   degradedResponseTime: 5000,
@@ -46,6 +47,7 @@ import { Frequency, UrlAssertionBuilder, UrlMonitor } from "checkly/constructs"
 
 new UrlMonitor("advanced-url-monitor", {
   name: "Advanced URL Monitor",
+  description: "**API health check** returns 200.",
   activated: true,
   frequency: Frequency.EVERY_5M,
   locations: ["us-east-1", "eu-west-1"],

detect/synthetic-monitoring/api-checks/overview.mdx

@@ -8,15 +8,17 @@ sidebarTitle: 'Overview'
 </Tip>  
 
 <Frame>
-<img 
-  className="block dark:hidden" 
-  src="/images/api-check-light.png" 
-  alt="Light mode interface"
+<img
+  className="block dark:hidden"
+  src="/images/api-check-light.png"
+  alt="API check overview"
+  style={{width: "100%"}}
 />
-<img 
-  className="hidden dark:block" 
-  src="/images/api-check-dark.png" 
-  alt="Dark mode interface"
+<img
+  className="hidden dark:block"
+  src="/images/api-check-dark.png"
+  alt="API check overview"
+  style={{width: "100%"}}
 />
 </Frame>