From 4eacd04c2a1409a8c60f1805fd198b2049b8ed3e Mon Sep 17 00:00:00 2001
From: Jeppe Bundgaard <jb@truckwash.dk>
Date: Tue, 27 Jan 2026 08:46:14 +0100
Subject: [PATCH] Update OpenAPI spec: Add progress alert customization fields
 to `goals_criteria` schema

- Introduce `progress_alert_destination`, `progress_alert_progress_type`, `progress_alert_style`, and `progress_alert_format` fields with descriptions, examples, and enum values.
- Ensure backward compatibility with support for camelCase inputs.
---
 openapi.yaml | 35 +++++++++++++++++++++++++++++++++++
 1 file changed, 35 insertions(+)

diff --git a/openapi.yaml b/openapi.yaml
index 3cef8bd0..b5ae8b81 100644
--- a/openapi.yaml
+++ b/openapi.yaml
@@ -6131,6 +6131,41 @@ components:
             For backward-compatibility the API also accepts camelCase `progressAlertFrequency` on input.
           enum: [DAILY, WEEKLY, MONTHLY, CHANGED, NONE]
           example: DAILY
+        progress_alert_destination:
+          type: string
+          description: |
+            Destination/channel where progress alerts should be delivered.
+            Accepted values: SLACK, EMAIL, SMS, NONE.
+            The canonical field name is snake_case `progress_alert_destination`.
+            For backward-compatibility the API also accepts camelCase `progressAlertDestination` on input.
+          enum: [SLACK, EMAIL, SMS, NONE]
+          example: NONE
+        progress_alert_progress_type:
+          type: string
+          description: |
+            What part of the progress should be included in alert messages.
+            Accepted values: ALL, PERCENTAGE_ONLY, COUNT_ONLY, COUNT_AND_TARGET, NONE.
+            The canonical field name is snake_case `progress_alert_progress_type`.
+            For backward-compatibility the API also accepts camelCase `progressAlertProgressType` on input.
+          enum: [ALL, PERCENTAGE_ONLY, COUNT_ONLY, COUNT_AND_TARGET, NONE]
+          example: ALL
+        progress_alert_style:
+          type: string
+          description: |
+            Presentation style of the alert.
+            Accepted values: DEPARTMENT_COMPARE, COLLECTIVE, SINGLE_DEPARTMENT, NONE.
+            The canonical field name is snake_case `progress_alert_style`.
+            For backward-compatibility the API also accepts camelCase `progressAlertStyle` on input.
+          enum: [DEPARTMENT_COMPARE, COLLECTIVE, SINGLE_DEPARTMENT, NONE]
+          example: NONE
+        progress_alert_format:
+          type: string
+          nullable: true
+          description: |
+            Optional custom template for the alert body. Supports tokens `{label}`, `{percent}`, `{count}`, `{target}`, `{timeframe}`, `{departments}`, `{prefix}`, `{body}`.
+            Max length depends on destination: 160 characters for SMS; 1024 characters for EMAIL/SLACK/other.
+            The canonical field name is snake_case `progress_alert_format`.
+            For backward-compatibility the API also accepts camelCase `progressAlertFormat` on input.
 
     DepartmentGoal:
       type: object