Add alert type query with name and description

Author: GregorShear

crates/control-plane-api/src/server/public/graphql/alert_types.rs

@@ -0,0 +1,30 @@
+use models::status::AlertType;
+
+#[derive(Debug, Default)]
+pub struct AlertTypesQuery;
+
+/// Describes an alert type with user-facing metadata.
+#[derive(Debug, Clone, async_graphql::SimpleObject)]
+pub struct AlertTypeInfo {
+    /// The alert type identifier.
+    alert_type: AlertType,
+    /// A short, user-facing title for the alert type.
+    title: String,
+    /// A user-facing description of what this alert type means.
+    description: String,
+}
+
+#[async_graphql::Object]
+impl AlertTypesQuery {
+    /// Returns all possible alert types with their user-facing metadata.
+    async fn alert_types(&self) -> Vec<AlertTypeInfo> {
+        AlertType::all()
+            .iter()
+            .map(|at| AlertTypeInfo {
+                alert_type: *at,
+                title: at.title().to_string(),
+                description: at.description().to_string(),
+            })
+            .collect()
+    }
+}

crates/control-plane-api/src/server/public/graphql/mod.rs

@@ -22,6 +22,7 @@ impl connection::CursorType for TimestampCursor {
 }
 
 mod alert_subscriptions;
+mod alert_types;
 mod alerts;
 mod authorized_prefixes;
 mod data_planes;
@@ -50,6 +51,7 @@ pub struct PgDataLoader(pub sqlx::PgPool);
 pub struct QueryRoot(
     live_spec_refs::LiveSpecsQuery,
     alerts::AlertsQuery,
+    alert_types::AlertTypesQuery,
     prefixes::PrefixesQuery,
     alert_subscriptions::AlertSubscriptionsQuery,
     storage_mappings::StorageMappingsQuery,

crates/models/src/status/alerts.rs

@@ -128,6 +128,65 @@ impl AlertType {
         }
     }
 
+    /// A short, user-facing title for the alert type.
+    pub fn title(&self) -> &'static str {
+        match self {
+            AlertType::AutoDiscoverFailed => "Auto-Discovery Failed",
+            AlertType::DataMovementStalled => "Data Movement Stalled",
+            AlertType::FreeTrial => "Free Trial",
+            AlertType::FreeTrialEnding => "Free Trial Ending",
+            AlertType::FreeTrialStalled => "Free Trial Stalled",
+            AlertType::MissingPaymentMethod => "Missing Payment Method",
+            AlertType::ShardFailed => "Task Failed",
+            AlertType::TaskChronicallyFailing => "Task Chronically Failing",
+            AlertType::TaskAutoDisabledFailing => "Task Auto-Disabled (Failing)",
+            AlertType::TaskIdle => "Task Idle",
+            AlertType::TaskAutoDisabledIdle => "Task Auto-Disabled (Idle)",
+            AlertType::BackgroundPublicationFailed => "Background Publication Failed",
+        }
+    }
+
+    /// A user-facing description of what this alert type means.
+    pub fn description(&self) -> &'static str {
+        match self {
+            AlertType::AutoDiscoverFailed => {
+                "Triggers when a capture's automated schema discovery fails. The capture may be unable to respond to schema changes in the source system."
+            }
+            AlertType::DataMovementStalled => {
+                "Triggers when a task has not processed any data during its configured alert interval."
+            }
+            AlertType::FreeTrial => {
+                "Triggers when a free trial begins, and resolves when the trial period ends."
+            }
+            AlertType::FreeTrialEnding => {
+                "Triggers when a free trial is getting close to expiring."
+            }
+            AlertType::FreeTrialStalled => {
+                "Triggers when a free trial has expired and no payment method has been added."
+            }
+            AlertType::MissingPaymentMethod => {
+                "Triggers when no payment method is on file, and resolves when one is added."
+            }
+            AlertType::ShardFailed => {
+                "Triggers when a task has experienced repeated failures. It may still make progress, but performance is degraded."
+            }
+            AlertType::TaskChronicallyFailing => {
+                "Triggers when a task has been unable to run for an extended period. It will be automatically disabled unless the issue is addressed."
+            }
+            AlertType::TaskAutoDisabledFailing => {
+                "Triggers when a task is automatically disabled after failing continuously for an extended period."
+            }
+            AlertType::TaskIdle => {
+                "Triggers when a task has not processed any data for an extended period and has not been modified recently. It will be automatically disabled unless a new version is published."
+            }
+            AlertType::TaskAutoDisabledIdle => {
+                "Triggers when a task is automatically disabled after being idle for an extended period without any spec changes."
+            }
+            AlertType::BackgroundPublicationFailed => {
+                "Triggers when an automated background publication fails. Affected tasks are unlikely to function until the issue is addressed."
+            }
+        }
+    }
     pub fn from_str(name: &str) -> Option<AlertType> {
         for alert_type in AlertType::all() {
             if name.eq_ignore_ascii_case(alert_type.name()) {