[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

src/main/java/com/datadog/api/client/v2/model/APITriggerWrapper.java

@@ -81,7 +81,7 @@ public APITriggerWrapper addStartStepNamesItem(String startStepNamesItem) {
   }
 
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    *
    * @return startStepNames
    */

src/main/java/com/datadog/api/client/v2/model/AppTriggerWrapper.java

@@ -76,7 +76,7 @@ public AppTriggerWrapper addStartStepNamesItem(String startStepNamesItem) {
   }
 
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    *
    * @return startStepNames
    */

src/main/java/com/datadog/api/client/v2/model/CaseTriggerWrapper.java

@@ -82,7 +82,7 @@ public CaseTriggerWrapper addStartStepNamesItem(String startStepNamesItem) {
   }
 
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    *
    * @return startStepNames
    */

src/main/java/com/datadog/api/client/v2/model/ChangeEventTriggerWrapper.java

@@ -77,7 +77,7 @@ public ChangeEventTriggerWrapper addStartStepNamesItem(String startStepNamesItem
   }
 
   /**
-   * A list of steps that run first after a trigger fires.
+   * Names of existing workflow steps that run first after a trigger fires.
    *
    * @return startStepNames
    */

src/main/java/com/datadog/api/client/v2/model/CompletionCondition.java

@@ -6,15 +6,11 @@
 
 package com.datadog.api.client.v2.model;
 
-import com.fasterxml.jackson.annotation.JsonAnyGetter;
-import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.Objects;
 
 /** The definition of <code>CompletionCondition</code> object. */
@@ -113,52 +109,6 @@ public void setOperator(CompletionConditionOperator operator) {
     this.operator = operator;
   }
 
-  /**
-   * A container for additional, undeclared properties. This is a holder for any undeclared
-   * properties as specified with the 'additionalProperties' keyword in the OAS document.
-   */
-  private Map<String, Object> additionalProperties;
-
-  /**
-   * Set the additional (undeclared) property with the specified name and value. If the property
-   * does not already exist, create it otherwise replace it.
-   *
-   * @param key The arbitrary key to set
-   * @param value The associated value
-   * @return CompletionCondition
-   */
-  @JsonAnySetter
-  public CompletionCondition putAdditionalProperty(String key, Object value) {
-    if (this.additionalProperties == null) {
-      this.additionalProperties = new HashMap<String, Object>();
-    }
-    this.additionalProperties.put(key, value);
-    return this;
-  }
-
-  /**
-   * Return the additional (undeclared) property.
-   *
-   * @return The additional properties
-   */
-  @JsonAnyGetter
-  public Map<String, Object> getAdditionalProperties() {
-    return additionalProperties;
-  }
-
-  /**
-   * Return the additional (undeclared) property with the specified name.
-   *
-   * @param key The arbitrary key to get
-   * @return The specific additional property for the given key
-   */
-  public Object getAdditionalProperty(String key) {
-    if (this.additionalProperties == null) {
-      return null;
-    }
-    return this.additionalProperties.get(key);
-  }
-
   /** Return true if this CompletionCondition object is equal to o. */
   @Override
   public boolean equals(Object o) {
@@ -171,13 +121,12 @@ public boolean equals(Object o) {
     CompletionCondition completionCondition = (CompletionCondition) o;
     return Objects.equals(this.operand1, completionCondition.operand1)
         && Objects.equals(this.operand2, completionCondition.operand2)
-        && Objects.equals(this.operator, completionCondition.operator)
-        && Objects.equals(this.additionalProperties, completionCondition.additionalProperties);
+        && Objects.equals(this.operator, completionCondition.operator);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(operand1, operand2, operator, additionalProperties);
+    return Objects.hash(operand1, operand2, operator);
   }
 
   @Override
@@ -187,9 +136,6 @@ public String toString() {
     sb.append("    operand1: ").append(toIndentedString(operand1)).append("\n");
     sb.append("    operand2: ").append(toIndentedString(operand2)).append("\n");
     sb.append("    operator: ").append(toIndentedString(operator)).append("\n");
-    sb.append("    additionalProperties: ")
-        .append(toIndentedString(additionalProperties))
-        .append("\n");
     sb.append('}');
     return sb.toString();
   }

src/main/java/com/datadog/api/client/v2/model/CompletionGate.java

@@ -6,15 +6,11 @@
 
 package com.datadog.api.client.v2.model;
 
-import com.fasterxml.jackson.annotation.JsonAnyGetter;
-import com.fasterxml.jackson.annotation.JsonAnySetter;
 import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
 import com.fasterxml.jackson.annotation.JsonPropertyOrder;
-import java.util.HashMap;
-import java.util.Map;
 import java.util.Objects;
 
 /** Used to create conditions before running subsequent actions. */
@@ -94,52 +90,6 @@ public void setRetryStrategy(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.
-   */
-  private Map<String, Object> additionalProperties;
-
-  /**
-   * Set the additional (undeclared) property with the specified name and value. If the property
-   * does not already exist, create it otherwise replace it.
-   *
-   * @param key The arbitrary key to set
-   * @param value The associated value
-   * @return CompletionGate
-   */
-  @JsonAnySetter
-  public CompletionGate putAdditionalProperty(String key, Object value) {
-    if (this.additionalProperties == null) {
-      this.additionalProperties = new HashMap<String, Object>();
-    }
-    this.additionalProperties.put(key, value);
-    return this;
-  }
-
-  /**
-   * Return the additional (undeclared) property.
-   *
-   * @return The additional properties
-   */
-  @JsonAnyGetter
-  public Map<String, Object> getAdditionalProperties() {
-    return additionalProperties;
-  }
-
-  /**
-   * Return the additional (undeclared) property with the specified name.
-   *
-   * @param key The arbitrary key to get
-   * @return The specific additional property for the given key
-   */
-  public Object getAdditionalProperty(String key) {
-    if (this.additionalProperties == null) {
-      return null;
-    }
-    return this.additionalProperties.get(key);
-  }
-
   /** Return true if this CompletionGate object is equal to o. */
   @Override
   public boolean equals(Object o) {
@@ -151,13 +101,12 @@ public boolean equals(Object o) {
     }
     CompletionGate completionGate = (CompletionGate) o;
     return Objects.equals(this.completionCondition, completionGate.completionCondition)
-        && Objects.equals(this.retryStrategy, completionGate.retryStrategy)
-        && Objects.equals(this.additionalProperties, completionGate.additionalProperties);
+        && Objects.equals(this.retryStrategy, completionGate.retryStrategy);
   }
 
   @Override
   public int hashCode() {
-    return Objects.hash(completionCondition, retryStrategy, additionalProperties);
+    return Objects.hash(completionCondition, retryStrategy);
   }
 
   @Override
@@ -168,9 +117,6 @@ public String toString() {
         .append(toIndentedString(completionCondition))
         .append("\n");
     sb.append("    retryStrategy: ").append(toIndentedString(retryStrategy)).append("\n");
-    sb.append("    additionalProperties: ")
-        .append(toIndentedString(additionalProperties))
-        .append("\n");
     sb.append('}');
     return sb.toString();
   }