wip: first pass at adding description to burn alerts

client/burn_alert.go

@@ -46,6 +46,7 @@ type BurnAlert struct {
 	ExhaustionMinutes                     *int                    `json:"exhaustion_minutes,omitempty"`
 	BudgetRateWindowMinutes               *int                    `json:"budget_rate_window_minutes,omitempty"`
 	BudgetRateDecreaseThresholdPerMillion *int                    `json:"budget_rate_decrease_threshold_per_million,omitempty"`
+	Description                           string                  `json:"description,omitempty"`
 	SLO                                   SLORef                  `json:"slo"`
 	CreatedAt                             time.Time               `json:"created_at,omitempty"`
 	UpdatedAt                             time.Time               `json:"updated_at,omitempty"`

internal/models/burn_alerts.go

@@ -7,6 +7,7 @@ type BurnAlertResourceModel struct {
 	AlertType                 types.String  `tfsdk:"alert_type"`
 	BudgetRateWindowMinutes   types.Int64   `tfsdk:"budget_rate_window_minutes"`
 	BudgetRateDecreasePercent types.Float64 `tfsdk:"budget_rate_decrease_percent"`
+	Description               types.String  `tfsdk:"description"`
 	Dataset                   types.String  `tfsdk:"dataset"`
 	SLOID                     types.String  `tfsdk:"slo_id"`
 	ExhaustionMinutes         types.Int64   `tfsdk:"exhaustion_minutes"`

internal/provider/burn_alert_resource.go

@@ -103,6 +103,13 @@ func (*burnAlertResource) Schema(_ context.Context, _ resource.SchemaRequest, re
 					stringplanmodifier.RequiresReplace(),
 				},
 			},
+			"description": schema.StringAttribute{
+				Description: "A description for this Burn Alert.",
+				Optional:    true,
+				Validators: []validator.String{
+					stringvalidator.LengthAtMost(1023),
+				},
+			},
 			"exhaustion_minutes": schema.Int64Attribute{
 				Optional:    true,
 				Description: "The amount of time, in minutes, remaining before the SLO's error budget will be exhausted and the alert will fire.",
@@ -235,9 +242,10 @@ func (r *burnAlertResource) Create(ctx context.Context, req resource.CreateReque
 
 	// Get attributes from config and construct the create request
 	createRequest := &client.BurnAlert{
-		AlertType:  client.BurnAlertAlertType(plan.AlertType.ValueString()),
-		Recipients: expandNotificationRecipients(ctx, plan.Recipients, &resp.Diagnostics),
-		SLO:        client.SLORef{ID: plan.SLOID.ValueString()},
+		AlertType:   client.BurnAlertAlertType(plan.AlertType.ValueString()),
+		Recipients:  expandNotificationRecipients(ctx, plan.Recipients, &resp.Diagnostics),
+		SLO:         client.SLORef{ID: plan.SLOID.ValueString()},
+		Description: string(plan.Description.ValueString()),
 	}
 
 	// Process any attributes that could be nil and add them to the create request
@@ -264,6 +272,7 @@ func (r *burnAlertResource) Create(ctx context.Context, req resource.CreateReque
 	state.ID = types.StringValue(burnAlert.ID)
 	state.AlertType = types.StringValue(string(burnAlert.AlertType))
 	state.Dataset = plan.Dataset
+	state.Description = plan.Description
 	// we created them as authored so to avoid matching type-target or ID we can just use the same value
 	state.Recipients = config.Recipients
 	state.SLOID = types.StringValue(burnAlert.SLO.ID)