Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 14 additions & 11 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -107302,9 +107304,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.
Expand Down
14 changes: 10 additions & 4 deletions src/datadog_api_client/v2/model/annotation.py
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@


class Annotation(ModelNormal):
validations = {
"id": {
"min_length": 1,
},
}

@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.annotation_display import AnnotationDisplay
Expand All @@ -38,15 +44,15 @@ def __init__(
self_, display: AnnotationDisplay, id: str, markdown_text_annotation: AnnotationMarkdownTextAnnotation, **kwargs
):
"""
A list of annotations used in the workflow. These are like sticky notes for your workflow!
A text annotation displayed on the workflow canvas.

:param display: The definition of ``AnnotationDisplay`` object.
:param display: The annotation's position and size on the workflow canvas.
:type display: AnnotationDisplay

:param id: The ``Annotation`` ``id``.
:param id: The unique identifier of this annotation within the workflow.
:type id: str

:param markdown_text_annotation: The definition of ``AnnotationMarkdownTextAnnotation`` object.
:param markdown_text_annotation: Markdown content displayed in an annotation.
:type markdown_text_annotation: AnnotationMarkdownTextAnnotation
"""
super().__init__(kwargs)
Expand Down
4 changes: 2 additions & 2 deletions src/datadog_api_client/v2/model/annotation_display.py
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,9 @@ def openapi_types(_):

def __init__(self_, bounds: Union[AnnotationDisplayBounds, UnsetType] = unset, **kwargs):
"""
The definition of ``AnnotationDisplay`` object.
The annotation's position and size on the workflow canvas.

:param bounds: The definition of ``AnnotationDisplayBounds`` object.
:param bounds: Canvas coordinates and dimensions for an annotation on the workflow canvas.
:type bounds: AnnotationDisplayBounds, optional
"""
if bounds is not unset:
Expand Down
10 changes: 5 additions & 5 deletions src/datadog_api_client/v2/model/annotation_display_bounds.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,18 +39,18 @@ def __init__(
**kwargs,
):
"""
The definition of ``AnnotationDisplayBounds`` object.
Canvas coordinates and dimensions for an annotation on the workflow canvas.

:param height: The ``bounds`` ``height``.
:param height: The annotation's height on the canvas.
:type height: float, optional

:param width: The ``bounds`` ``width``.
:param width: The annotation's width on the canvas.
:type width: float, optional

:param x: The ``bounds`` ``x``.
:param x: The annotation's horizontal canvas coordinate.
:type x: float, optional

:param y: The ``bounds`` ``y``.
:param y: The annotation's vertical canvas coordinate.
:type y: float, optional
"""
if height is not unset:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@


class AnnotationMarkdownTextAnnotation(ModelNormal):
validations = {
"text": {
"max_length": 3000,
},
}

@cached_property
def openapi_types(_):
return {
Expand All @@ -26,9 +32,9 @@ def openapi_types(_):

def __init__(self_, text: Union[str, UnsetType] = unset, **kwargs):
"""
The definition of ``AnnotationMarkdownTextAnnotation`` object.
Markdown content displayed in an annotation.

:param text: The ``markdownTextAnnotation`` ``text``.
:param text: The annotation's Markdown content.
:type text: str, optional
"""
if text is not unset:
Expand Down
8 changes: 7 additions & 1 deletion src/datadog_api_client/v2/model/spec.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,12 @@


class Spec(ModelNormal):
validations = {
"annotations": {
"max_items": 100,
},
}

@cached_property
def openapi_types(_):
from datadog_api_client.v2.model.annotation import Annotation
Expand Down Expand Up @@ -113,7 +119,7 @@ def __init__(
"""
A complete Workflow Automation definition, including its triggers, steps, and connections.

:param annotations: A list of annotations used in the workflow. These are like sticky notes for your workflow!
:param annotations: Up to 100 text annotations displayed on the workflow canvas.
:type annotations: [Annotation], optional

:param connection_envs: A list of connections or connection groups used in the workflow.
Expand Down
Loading