[Workflow Automation] Clarify and Constrain Workflow Spec Fields

.generator/schemas/v2/openapi.yaml

@@ -20419,6 +20419,7 @@ components:
         - times
       type: object
     CompletionCondition:
+      additionalProperties: false
       description: The definition of `CompletionCondition` object.
       properties:
         operand1:
@@ -20462,6 +20463,7 @@ components:
         - OPERATOR_IS_EMPTY
         - OPERATOR_IS_NOT_EMPTY
     CompletionGate:
+      additionalProperties: false
       description: Used to create conditions before running subsequent actions.
       properties:
         completionCondition:
@@ -36028,6 +36030,7 @@ components:
           type: integer
       type: object
     ErrorHandler:
+      additionalProperties: false
       description: Used to handle errors in an action.
       properties:
         fallbackStepName:
@@ -51951,6 +51954,7 @@ components:
         name:
           description: The `InputSchemaParameters` `name`.
           example: ""
+          minLength: 1
           type: string
         type:
           $ref: "#/components/schemas/InputSchemaParametersType"
@@ -78536,11 +78540,13 @@ components:
       properties:
         branchName:
           description: The `OutboundEdge` `branchName`.
-          example: ""
+          example: main
+          minLength: 1
           type: string
         nextStepName:
           description: The `OutboundEdge` `nextStepName`.
-          example: ""
+          example: Step2
+          minLength: 1
           type: string
       required:
         - nextStepName
@@ -79690,6 +79696,7 @@ components:
         name:
           description: The `Parameter` `name`.
           example: ""
+          minLength: 1
           type: string
         value:
           description: The `Parameter` `value`.
@@ -84923,6 +84930,7 @@ components:
         - attributes
       type: object
     ReadinessGate:
+      additionalProperties: false
       description: Used to merge multiple branches into a single branch.
       properties:
         thresholdType:
@@ -87404,6 +87412,7 @@ components:
         - data
       type: object
     RetryStrategy:
+      additionalProperties: false
       description: The definition of `RetryStrategy` object.
       properties:
         kind:
@@ -87412,6 +87421,7 @@ components:
           $ref: "#/components/schemas/RetryStrategyLinear"
       required:
         - kind
+        - linear
       type: object
     RetryStrategyKind:
       description: The definition of `RetryStrategyKind` object.
@@ -87422,17 +87432,21 @@ components:
       x-enum-varnames:
         - RETRY_STRATEGY_LINEAR
     RetryStrategyLinear:
+      additionalProperties: false
       description: The definition of `RetryStrategyLinear` object.
       properties:
         interval:
           description: The `RetryStrategyLinear` `interval`. The expected format is the number of seconds ending with an s. For example, 1 day is 86400s
           example: ""
+          pattern: ^[1-9][0-9]*s$
           type: string
         maxRetries:
           description: The `RetryStrategyLinear` `maxRetries`.
-          example: 0.0
-          format: double
-          type: number
+          example: 0
+          format: int32
+          maximum: 2147483647
+          minimum: 0
+          type: integer
       required:
         - interval
         - maxRetries
@@ -103966,7 +103980,7 @@ components:
           type: string
       type: object
     Spec:
-      description: The spec defines what the workflow does.
+      description: A complete Workflow Automation definition, including its triggers, steps, and connections.
       properties:
         annotations:
           description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!"
@@ -104084,11 +104098,12 @@ components:
         - type
       type: object
     StartStepNames:
-      description: "A list of steps that run first after a trigger fires."
+      description: "Names of existing workflow steps that run first after a trigger fires."
       example:
         - ""
       items:
         description: The `StartStepNames` `items`.
+        minLength: 1
         type: string
       type: array
     State:
@@ -105364,6 +105379,7 @@ components:
         actionId:
           description: The unique identifier of an action.
           example: ""
+          minLength: 1
           type: string
         completionGate:
           $ref: "#/components/schemas/CompletionGate"
@@ -105380,9 +105396,10 @@ components:
         name:
           description: Name of the step.
           example: ""
+          minLength: 1
           type: string
         outboundEdges:
-          description: A list of subsequent actions to run.
+          description: A list of subsequent actions to run. This list is empty for a terminal step.
           items:
             $ref: "#/components/schemas/OutboundEdge"
           type: array
@@ -105398,7 +105415,9 @@ components:
         - actionId
       type: object
     StepDisplay:
-      description: The definition of `StepDisplay` object.
+      description: |-
+        The position of a step on the workflow canvas. Omit `display` from every step to use
+        automatic layout, or provide it for every step to preserve a manual layout.
       properties:
         bounds:
           $ref: "#/components/schemas/StepDisplayBounds"
@@ -119151,7 +119170,7 @@ components:
         startStepNames:
           $ref: "#/components/schemas/StartStepNames"
         workflowTrigger:
-          description: "Trigger a workflow from the Datadog UI. Only required if no other trigger exists."
+          description: "Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger."
           type: object
       required:
         - workflowTrigger

services/workflow_automation/src/v2/models/APITriggerWrapper.ts

@@ -11,7 +11,7 @@ export class APITriggerWrapper {
    */
   "apiTrigger": APITrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/AppTriggerWrapper.ts

@@ -9,7 +9,7 @@ export class AppTriggerWrapper {
    */
   "appTrigger": any;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/CaseTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class CaseTriggerWrapper {
    */
   "caseTrigger": CaseTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/ChangeEventTriggerWrapper.ts

@@ -9,7 +9,7 @@ export class ChangeEventTriggerWrapper {
    */
   "changeEventTrigger": any;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/CompletionCondition.ts

@@ -18,12 +18,6 @@ export class CompletionCondition {
    * The definition of `CompletionConditionOperator` object.
    */
   "operator": CompletionConditionOperator;
-  /**
-   * A container for additional, undeclared properties.
-   * This is a holder for any undeclared properties as specified with
-   * the 'additionalProperties' keyword in the OAS document.
-   */
-  "additionalProperties"?: { [key: string]: any };
   /**
    * @ignore
    */
@@ -47,10 +41,6 @@ export class CompletionCondition {
       type: "CompletionConditionOperator",
       required: true,
     },
-    additionalProperties: {
-      baseName: "additionalProperties",
-      type: "{ [key: string]: any; }",
-    },
   };
 
   /**

services/workflow_automation/src/v2/models/CompletionGate.ts

@@ -15,12 +15,6 @@ export class CompletionGate {
    * The definition of `RetryStrategy` object.
    */
   "retryStrategy": RetryStrategy;
-  /**
-   * A container for additional, undeclared properties.
-   * This is a holder for any undeclared properties as specified with
-   * the 'additionalProperties' keyword in the OAS document.
-   */
-  "additionalProperties"?: { [key: string]: any };
   /**
    * @ignore
    */
@@ -40,10 +34,6 @@ export class CompletionGate {
       type: "RetryStrategy",
       required: true,
     },
-    additionalProperties: {
-      baseName: "additionalProperties",
-      type: "{ [key: string]: any; }",
-    },
   };
 
   /**

services/workflow_automation/src/v2/models/DashboardTriggerWrapper.ts

@@ -9,7 +9,7 @@ export class DashboardTriggerWrapper {
    */
   "dashboardTrigger": any;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/DatabaseMonitoringTriggerWrapper.ts

@@ -9,7 +9,7 @@ export class DatabaseMonitoringTriggerWrapper {
    */
   "databaseMonitoringTrigger": any;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/DatastoreTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class DatastoreTriggerWrapper {
    */
   "datastoreTrigger": DatastoreTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/ErrorHandler.ts

@@ -14,12 +14,6 @@ export class ErrorHandler {
    * The definition of `RetryStrategy` object.
    */
   "retryStrategy": RetryStrategy;
-  /**
-   * A container for additional, undeclared properties.
-   * This is a holder for any undeclared properties as specified with
-   * the 'additionalProperties' keyword in the OAS document.
-   */
-  "additionalProperties"?: { [key: string]: any };
   /**
    * @ignore
    */
@@ -39,10 +33,6 @@ export class ErrorHandler {
       type: "RetryStrategy",
       required: true,
     },
-    additionalProperties: {
-      baseName: "additionalProperties",
-      type: "{ [key: string]: any; }",
-    },
   };
 
   /**

services/workflow_automation/src/v2/models/FormTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class FormTriggerWrapper {
    */
   "formTrigger": FormTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/GithubWebhookTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class GithubWebhookTriggerWrapper {
    */
   "githubWebhookTrigger": GithubWebhookTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/IncidentTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class IncidentTriggerWrapper {
    */
   "incidentTrigger": IncidentTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/MonitorTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class MonitorTriggerWrapper {
    */
   "monitorTrigger": MonitorTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/NotebookTriggerWrapper.ts

@@ -9,7 +9,7 @@ export class NotebookTriggerWrapper {
    */
   "notebookTrigger": any;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/OnCallTriggerWrapper.ts

@@ -11,7 +11,7 @@ export class OnCallTriggerWrapper {
    */
   "onCallTrigger": OnCallTrigger;
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    */
   "startStepNames"?: Array<string>;
   /**

services/workflow_automation/src/v2/models/ReadinessGate.ts

@@ -10,12 +10,6 @@ export class ReadinessGate {
    * The definition of `ReadinessGateThresholdType` object.
    */
   "thresholdType": ReadinessGateThresholdType;
-  /**
-   * A container for additional, undeclared properties.
-   * This is a holder for any undeclared properties as specified with
-   * the 'additionalProperties' keyword in the OAS document.
-   */
-  "additionalProperties"?: { [key: string]: any };
   /**
    * @ignore
    */
@@ -30,10 +24,6 @@ export class ReadinessGate {
       type: "ReadinessGateThresholdType",
       required: true,
     },
-    additionalProperties: {
-      baseName: "additionalProperties",
-      type: "{ [key: string]: any; }",
-    },
   };
 
   /**