Skip to content

Commit 3ef604b

Browse files
authored
docs: add simple TSDocs for IncidentTrigger (#1141)
1 parent 2aedf94 commit 3ef604b

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

packages/cli/src/constructs/incident.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,9 +3,14 @@ import { StatusPageService } from './status-page-service'
33
type IncidentSeverity = 'MINOR' | 'MEDIUM' | 'MAJOR' | 'CRITICAL'
44

55
export interface IncidentTrigger {
6+
/** The status page service that this incident will be associated with. */
67
service: StatusPageService
8+
/** The severity level of the incident. */
79
severity: IncidentSeverity
10+
/** The name of the incident. */
811
name: string
12+
/** A detailed description of the incident. */
913
description: string
14+
/** Whether to notify subscribers when the incident is triggered. */
1015
notifySubscribers: boolean
1116
}

0 commit comments

Comments
 (0)