Improve Workflow Automation annotation schema guidance

.generator/schemas/v2/openapi.yaml

@@ -7199,13 +7199,14 @@ components:
         - fixes
       type: object
     Annotation:
-      description: "A list of annotations used in the workflow. These are like sticky notes for your workflow!"
+      description: A text annotation displayed on the workflow canvas.
       properties:
         display:
           $ref: "#/components/schemas/AnnotationDisplay"
         id:
-          description: The `Annotation` `id`.
+          description: The unique identifier of this annotation within the workflow.
           example: ""
+          minLength: 1
           type: string
         markdownTextAnnotation:
           $ref: "#/components/schemas/AnnotationMarkdownTextAnnotation"
@@ -7362,28 +7363,28 @@ components:
         - attributes
       type: object
     AnnotationDisplay:
-      description: The definition of `AnnotationDisplay` object.
+      description: The annotation's position and size on the workflow canvas.
       properties:
         bounds:
           $ref: "#/components/schemas/AnnotationDisplayBounds"
       type: object
     AnnotationDisplayBounds:
-      description: The definition of `AnnotationDisplayBounds` object.
+      description: Canvas coordinates and dimensions for an annotation on the workflow canvas.
       properties:
         height:
-          description: The `bounds` `height`.
+          description: The annotation's height on the canvas.
           format: double
           type: number
         width:
-          description: The `bounds` `width`.
+          description: The annotation's width on the canvas.
           format: double
           type: number
         x:
-          description: The `bounds` `x`.
+          description: The annotation's horizontal canvas coordinate.
           format: double
           type: number
         y:
-          description: The `bounds` `y`.
+          description: The annotation's vertical canvas coordinate.
           format: double
           type: number
       type: object
@@ -7467,10 +7468,11 @@ components:
         - POINT_IN_TIME
         - TIME_REGION
     AnnotationMarkdownTextAnnotation:
-      description: The definition of `AnnotationMarkdownTextAnnotation` object.
+      description: Markdown content displayed in an annotation.
       properties:
         text:
-          description: The `markdownTextAnnotation` `text`.
+          description: The annotation's Markdown content.
+          maxLength: 3000
           type: string
       type: object
     AnnotationRequestData:
@@ -105142,9 +105144,10 @@ components:
       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!"
+          description: Up to 100 text annotations displayed on the workflow canvas.
           items:
             $ref: "#/components/schemas/Annotation"
+          maxItems: 100
           type: array
         connectionEnvs:
           description: A list of connections or connection groups used in the workflow.

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

@@ -17,7 +17,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** A list of annotations used in the workflow. These are like sticky notes for your workflow! */
+/** A text annotation displayed on the workflow canvas. */
 @JsonPropertyOrder({
   Annotation.JSON_PROPERTY_DISPLAY,
   Annotation.JSON_PROPERTY_ID,
@@ -58,7 +58,7 @@ public Annotation display(AnnotationDisplay display) {
   }
 
   /**
-   * The definition of <code>AnnotationDisplay</code> object.
+   * The annotation's position and size on the workflow canvas.
    *
    * @return display
    */
@@ -81,7 +81,7 @@ public Annotation id(String id) {
   }
 
   /**
-   * The <code>Annotation</code> <code>id</code>.
+   * The unique identifier of this annotation within the workflow.
    *
    * @return id
    */
@@ -103,7 +103,7 @@ public Annotation markdownTextAnnotation(
   }
 
   /**
-   * The definition of <code>AnnotationMarkdownTextAnnotation</code> object.
+   * Markdown content displayed in an annotation.
    *
    * @return markdownTextAnnotation
    */

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

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** The definition of <code>AnnotationDisplay</code> object. */
+/** The annotation's position and size on the workflow canvas. */
 @JsonPropertyOrder({AnnotationDisplay.JSON_PROPERTY_BOUNDS})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -32,7 +32,7 @@ public AnnotationDisplay bounds(AnnotationDisplayBounds bounds) {
   }
 
   /**
-   * The definition of <code>AnnotationDisplayBounds</code> object.
+   * Canvas coordinates and dimensions for an annotation on the workflow canvas.
    *
    * @return bounds
    */

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

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** The definition of <code>AnnotationDisplayBounds</code> object. */
+/** Canvas coordinates and dimensions for an annotation on the workflow canvas. */
 @JsonPropertyOrder({
   AnnotationDisplayBounds.JSON_PROPERTY_HEIGHT,
   AnnotationDisplayBounds.JSON_PROPERTY_WIDTH,
@@ -45,7 +45,7 @@ public AnnotationDisplayBounds height(Double height) {
   }
 
   /**
-   * The <code>bounds</code> <code>height</code>.
+   * The annotation's height on the canvas.
    *
    * @return height
    */
@@ -66,7 +66,7 @@ public AnnotationDisplayBounds width(Double width) {
   }
 
   /**
-   * The <code>bounds</code> <code>width</code>.
+   * The annotation's width on the canvas.
    *
    * @return width
    */
@@ -87,7 +87,7 @@ public AnnotationDisplayBounds x(Double x) {
   }
 
   /**
-   * The <code>bounds</code> <code>x</code>.
+   * The annotation's horizontal canvas coordinate.
    *
    * @return x
    */
@@ -108,7 +108,7 @@ public AnnotationDisplayBounds y(Double y) {
   }
 
   /**
-   * The <code>bounds</code> <code>y</code>.
+   * The annotation's vertical canvas coordinate.
    *
    * @return y
    */

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

@@ -16,7 +16,7 @@
 import java.util.Map;
 import java.util.Objects;
 
-/** The definition of <code>AnnotationMarkdownTextAnnotation</code> object. */
+/** Markdown content displayed in an annotation. */
 @JsonPropertyOrder({AnnotationMarkdownTextAnnotation.JSON_PROPERTY_TEXT})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
@@ -31,7 +31,7 @@ public AnnotationMarkdownTextAnnotation text(String text) {
   }
 
   /**
-   * The <code>markdownTextAnnotation</code> <code>text</code>.
+   * The annotation's Markdown content.
    *
    * @return text
    */

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

@@ -73,7 +73,7 @@ public Spec addAnnotationsItem(Annotation annotationsItem) {
   }
 
   /**
-   * A list of annotations used in the workflow. These are like sticky notes for your workflow!
+   * Up to 100 text annotations displayed on the workflow canvas.
    *
    * @return annotations
    */