From b6818196aef1ed2caab36ec7cace1d2fe7fa54bb Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 5 Aug 2026 20:53:19 +0000 Subject: [PATCH] Regenerate client from commit 9db2f1c of spec repo --- .generator/schemas/v2/openapi.yaml | 39 ++++++++++++++----- .../v2/model/api_trigger_wrapper.py | 2 +- .../v2/model/app_trigger_wrapper.py | 2 +- .../v2/model/case_trigger_wrapper.py | 2 +- .../v2/model/change_event_trigger_wrapper.py | 2 +- .../v2/model/completion_condition.py | 4 ++ .../v2/model/completion_gate.py | 4 ++ .../v2/model/dashboard_trigger_wrapper.py | 2 +- .../database_monitoring_trigger_wrapper.py | 2 +- .../v2/model/datastore_trigger_wrapper.py | 2 +- .../v2/model/error_handler.py | 4 ++ .../v2/model/form_trigger_wrapper.py | 2 +- .../model/github_webhook_trigger_wrapper.py | 2 +- .../v2/model/incident_trigger_wrapper.py | 2 +- .../v2/model/input_schema_parameters.py | 6 +++ .../v2/model/monitor_trigger_wrapper.py | 2 +- .../v2/model/notebook_trigger_wrapper.py | 2 +- .../v2/model/on_call_trigger_wrapper.py | 2 +- .../v2/model/outbound_edge.py | 9 +++++ src/datadog_api_client/v2/model/parameter.py | 6 +++ .../v2/model/readiness_gate.py | 4 ++ .../v2/model/retry_strategy.py | 15 +++---- .../v2/model/retry_strategy_linear.py | 18 +++++++-- .../v2/model/schedule_trigger_wrapper.py | 2 +- .../v2/model/security_trigger_wrapper.py | 2 +- .../v2/model/self_service_trigger_wrapper.py | 2 +- .../v2/model/slack_trigger_wrapper.py | 2 +- .../model/software_catalog_trigger_wrapper.py | 2 +- src/datadog_api_client/v2/model/spec.py | 2 +- src/datadog_api_client/v2/model/step.py | 14 ++++++- .../v2/model/step_display.py | 3 +- src/datadog_api_client/v2/model/trigger.py | 4 +- .../v2/model/workflow_data_attributes.py | 2 +- .../model/workflow_data_update_attributes.py | 2 +- .../v2/model/workflow_list_item_attributes.py | 2 +- .../v2/model/workflow_trigger_wrapper.py | 4 +- 36 files changed, 129 insertions(+), 49 deletions(-) diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml index 05592fbb55..eeb537b688 100644 --- a/.generator/schemas/v2/openapi.yaml +++ b/.generator/schemas/v2/openapi.yaml @@ -20436,6 +20436,7 @@ components: - times type: object CompletionCondition: + additionalProperties: false description: The definition of `CompletionCondition` object. properties: operand1: @@ -20479,6 +20480,7 @@ components: - OPERATOR_IS_EMPTY - OPERATOR_IS_NOT_EMPTY CompletionGate: + additionalProperties: false description: Used to create conditions before running subsequent actions. properties: completionCondition: @@ -35926,6 +35928,7 @@ components: type: integer type: object ErrorHandler: + additionalProperties: false description: Used to handle errors in an action. properties: fallbackStepName: @@ -51711,6 +51714,7 @@ components: name: description: The `InputSchemaParameters` `name`. example: "" + minLength: 1 type: string type: $ref: "#/components/schemas/InputSchemaParametersType" @@ -78296,11 +78300,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 @@ -79450,6 +79456,7 @@ components: name: description: The `Parameter` `name`. example: "" + minLength: 1 type: string value: description: The `Parameter` `value`. @@ -84683,6 +84690,7 @@ components: - attributes type: object ReadinessGate: + additionalProperties: false description: Used to merge multiple branches into a single branch. properties: thresholdType: @@ -87164,6 +87172,7 @@ components: - data type: object RetryStrategy: + additionalProperties: false description: The definition of `RetryStrategy` object. properties: kind: @@ -87172,6 +87181,7 @@ components: $ref: "#/components/schemas/RetryStrategyLinear" required: - kind + - linear type: object RetryStrategyKind: description: The definition of `RetryStrategyKind` object. @@ -87182,17 +87192,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 @@ -103899,7 +103913,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!" @@ -104017,11 +104031,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: @@ -105297,6 +105312,7 @@ components: actionId: description: The unique identifier of an action. example: "" + minLength: 1 type: string completionGate: $ref: "#/components/schemas/CompletionGate" @@ -105313,9 +105329,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 @@ -105331,7 +105348,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" @@ -119084,7 +119103,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 diff --git a/src/datadog_api_client/v2/model/api_trigger_wrapper.py b/src/datadog_api_client/v2/model/api_trigger_wrapper.py index f256858124..d0033044f8 100644 --- a/src/datadog_api_client/v2/model/api_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/api_trigger_wrapper.py @@ -39,7 +39,7 @@ def __init__(self_, api_trigger: APITrigger, start_step_names: Union[List[str], :param api_trigger: Trigger a workflow from an API request. The workflow must be published. :type api_trigger: APITrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/app_trigger_wrapper.py b/src/datadog_api_client/v2/model/app_trigger_wrapper.py index 8d3bd13e57..ec878387cb 100644 --- a/src/datadog_api_client/v2/model/app_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/app_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, app_trigger: dict, start_step_names: Union[List[str], UnsetT :param app_trigger: Trigger a workflow from an App. :type app_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/case_trigger_wrapper.py b/src/datadog_api_client/v2/model/case_trigger_wrapper.py index ad58402518..1b294adc97 100644 --- a/src/datadog_api_client/v2/model/case_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/case_trigger_wrapper.py @@ -39,7 +39,7 @@ def __init__(self_, case_trigger: CaseTrigger, start_step_names: Union[List[str] :param case_trigger: Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published. :type case_trigger: CaseTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/change_event_trigger_wrapper.py b/src/datadog_api_client/v2/model/change_event_trigger_wrapper.py index e7d356d725..7ca91b10d2 100644 --- a/src/datadog_api_client/v2/model/change_event_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/change_event_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, change_event_trigger: dict, start_step_names: Union[List[str :param change_event_trigger: Trigger a workflow from a Change Event. :type change_event_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/completion_condition.py b/src/datadog_api_client/v2/model/completion_condition.py index 245c23206a..6758c5a65f 100644 --- a/src/datadog_api_client/v2/model/completion_condition.py +++ b/src/datadog_api_client/v2/model/completion_condition.py @@ -22,6 +22,10 @@ class CompletionCondition(ModelNormal): + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): from datadog_api_client.v2.model.completion_condition_operator import CompletionConditionOperator diff --git a/src/datadog_api_client/v2/model/completion_gate.py b/src/datadog_api_client/v2/model/completion_gate.py index bf2ce4d040..16c9957f07 100644 --- a/src/datadog_api_client/v2/model/completion_gate.py +++ b/src/datadog_api_client/v2/model/completion_gate.py @@ -17,6 +17,10 @@ class CompletionGate(ModelNormal): + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): from datadog_api_client.v2.model.completion_condition import CompletionCondition diff --git a/src/datadog_api_client/v2/model/dashboard_trigger_wrapper.py b/src/datadog_api_client/v2/model/dashboard_trigger_wrapper.py index a847fd9359..da485d46dc 100644 --- a/src/datadog_api_client/v2/model/dashboard_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/dashboard_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, dashboard_trigger: dict, start_step_names: Union[List[str], :param dashboard_trigger: Trigger a workflow from a Dashboard. :type dashboard_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/database_monitoring_trigger_wrapper.py b/src/datadog_api_client/v2/model/database_monitoring_trigger_wrapper.py index 5de92a3df0..1c9127ba07 100644 --- a/src/datadog_api_client/v2/model/database_monitoring_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/database_monitoring_trigger_wrapper.py @@ -35,7 +35,7 @@ def __init__( :param database_monitoring_trigger: Trigger a workflow from Database Monitoring. :type database_monitoring_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/datastore_trigger_wrapper.py b/src/datadog_api_client/v2/model/datastore_trigger_wrapper.py index 095c73861d..085ae4e382 100644 --- a/src/datadog_api_client/v2/model/datastore_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/datastore_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param datastore_trigger: Trigger a workflow from a Datastore. For automatic triggering a handle must be configured and the workflow must be published. :type datastore_trigger: DatastoreTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/error_handler.py b/src/datadog_api_client/v2/model/error_handler.py index f9f9c2c089..4ef880a3f9 100644 --- a/src/datadog_api_client/v2/model/error_handler.py +++ b/src/datadog_api_client/v2/model/error_handler.py @@ -16,6 +16,10 @@ class ErrorHandler(ModelNormal): + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): from datadog_api_client.v2.model.retry_strategy import RetryStrategy diff --git a/src/datadog_api_client/v2/model/form_trigger_wrapper.py b/src/datadog_api_client/v2/model/form_trigger_wrapper.py index a51ad8f6f7..0d80f03a72 100644 --- a/src/datadog_api_client/v2/model/form_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/form_trigger_wrapper.py @@ -39,7 +39,7 @@ def __init__(self_, form_trigger: FormTrigger, start_step_names: Union[List[str] :param form_trigger: Trigger a workflow from a Form. :type form_trigger: FormTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/github_webhook_trigger_wrapper.py b/src/datadog_api_client/v2/model/github_webhook_trigger_wrapper.py index cceabde43e..ef060c3db7 100644 --- a/src/datadog_api_client/v2/model/github_webhook_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/github_webhook_trigger_wrapper.py @@ -44,7 +44,7 @@ def __init__( :param github_webhook_trigger: Trigger a workflow from a GitHub webhook. To trigger a workflow from GitHub, you must set a ``webhookSecret``. In your GitHub Webhook Settings, set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id", select application/json for the content type, and be highly recommend enabling SSL verification for security. The workflow must be published. :type github_webhook_trigger: GithubWebhookTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/incident_trigger_wrapper.py b/src/datadog_api_client/v2/model/incident_trigger_wrapper.py index cfac755792..9a60ce4e1b 100644 --- a/src/datadog_api_client/v2/model/incident_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/incident_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param incident_trigger: Trigger a workflow from an Incident. For automatic triggering a handle must be configured and the workflow must be published. :type incident_trigger: IncidentTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/input_schema_parameters.py b/src/datadog_api_client/v2/model/input_schema_parameters.py index f0042237df..51e26e1292 100644 --- a/src/datadog_api_client/v2/model/input_schema_parameters.py +++ b/src/datadog_api_client/v2/model/input_schema_parameters.py @@ -22,6 +22,12 @@ class InputSchemaParameters(ModelNormal): + validations = { + "name": { + "min_length": 1, + }, + } + @cached_property def openapi_types(_): from datadog_api_client.v2.model.input_schema_parameters_type import InputSchemaParametersType diff --git a/src/datadog_api_client/v2/model/monitor_trigger_wrapper.py b/src/datadog_api_client/v2/model/monitor_trigger_wrapper.py index c1129b2770..e54704dbeb 100644 --- a/src/datadog_api_client/v2/model/monitor_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/monitor_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param monitor_trigger: Trigger a workflow from a Monitor. For automatic triggering a handle must be configured and the workflow must be published. :type monitor_trigger: MonitorTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/notebook_trigger_wrapper.py b/src/datadog_api_client/v2/model/notebook_trigger_wrapper.py index 717e9fec9c..a4607595a7 100644 --- a/src/datadog_api_client/v2/model/notebook_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/notebook_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, notebook_trigger: dict, start_step_names: Union[List[str], U :param notebook_trigger: Trigger a workflow from a Notebook. :type notebook_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/on_call_trigger_wrapper.py b/src/datadog_api_client/v2/model/on_call_trigger_wrapper.py index 5920b9cea3..57361f228b 100644 --- a/src/datadog_api_client/v2/model/on_call_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/on_call_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param on_call_trigger: Trigger a workflow from an On-Call Page or On-Call Handover. For automatic triggering a handle must be configured and the workflow must be published. :type on_call_trigger: OnCallTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/outbound_edge.py b/src/datadog_api_client/v2/model/outbound_edge.py index 42ae64b921..597ef4fa04 100644 --- a/src/datadog_api_client/v2/model/outbound_edge.py +++ b/src/datadog_api_client/v2/model/outbound_edge.py @@ -11,6 +11,15 @@ class OutboundEdge(ModelNormal): + validations = { + "branch_name": { + "min_length": 1, + }, + "next_step_name": { + "min_length": 1, + }, + } + @cached_property def openapi_types(_): return { diff --git a/src/datadog_api_client/v2/model/parameter.py b/src/datadog_api_client/v2/model/parameter.py index 6c01bda05d..d621c19ec5 100644 --- a/src/datadog_api_client/v2/model/parameter.py +++ b/src/datadog_api_client/v2/model/parameter.py @@ -16,6 +16,12 @@ class Parameter(ModelNormal): + validations = { + "name": { + "min_length": 1, + }, + } + @cached_property def openapi_types(_): return { diff --git a/src/datadog_api_client/v2/model/readiness_gate.py b/src/datadog_api_client/v2/model/readiness_gate.py index e26e781996..15658f2b87 100644 --- a/src/datadog_api_client/v2/model/readiness_gate.py +++ b/src/datadog_api_client/v2/model/readiness_gate.py @@ -16,6 +16,10 @@ class ReadinessGate(ModelNormal): + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): from datadog_api_client.v2.model.readiness_gate_threshold_type import ReadinessGateThresholdType diff --git a/src/datadog_api_client/v2/model/retry_strategy.py b/src/datadog_api_client/v2/model/retry_strategy.py index 27bda447cf..ca6d11b358 100644 --- a/src/datadog_api_client/v2/model/retry_strategy.py +++ b/src/datadog_api_client/v2/model/retry_strategy.py @@ -3,13 +3,11 @@ # Copyright 2019-Present Datadog, Inc. from __future__ import annotations -from typing import Union, TYPE_CHECKING +from typing import TYPE_CHECKING from datadog_api_client.model_utils import ( ModelNormal, cached_property, - unset, - UnsetType, ) @@ -19,6 +17,10 @@ class RetryStrategy(ModelNormal): + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): from datadog_api_client.v2.model.retry_strategy_kind import RetryStrategyKind @@ -34,7 +36,7 @@ def openapi_types(_): "linear": "linear", } - def __init__(self_, kind: RetryStrategyKind, linear: Union[RetryStrategyLinear, UnsetType] = unset, **kwargs): + def __init__(self_, kind: RetryStrategyKind, linear: RetryStrategyLinear, **kwargs): """ The definition of ``RetryStrategy`` object. @@ -42,10 +44,9 @@ def __init__(self_, kind: RetryStrategyKind, linear: Union[RetryStrategyLinear, :type kind: RetryStrategyKind :param linear: The definition of ``RetryStrategyLinear`` object. - :type linear: RetryStrategyLinear, optional + :type linear: RetryStrategyLinear """ - if linear is not unset: - kwargs["linear"] = linear super().__init__(kwargs) self_.kind = kind + self_.linear = linear diff --git a/src/datadog_api_client/v2/model/retry_strategy_linear.py b/src/datadog_api_client/v2/model/retry_strategy_linear.py index caf4d4fd83..2d7aaf2e15 100644 --- a/src/datadog_api_client/v2/model/retry_strategy_linear.py +++ b/src/datadog_api_client/v2/model/retry_strategy_linear.py @@ -11,11 +11,23 @@ class RetryStrategyLinear(ModelNormal): + validations = { + "interval": {}, + "max_retries": { + "inclusive_maximum": 2147483647, + "inclusive_minimum": 0, + }, + } + + @cached_property + def additional_properties_type(_): + return None + @cached_property def openapi_types(_): return { "interval": (str,), - "max_retries": (float,), + "max_retries": (int,), } attribute_map = { @@ -23,7 +35,7 @@ def openapi_types(_): "max_retries": "maxRetries", } - def __init__(self_, interval: str, max_retries: float, **kwargs): + def __init__(self_, interval: str, max_retries: int, **kwargs): """ The definition of ``RetryStrategyLinear`` object. @@ -31,7 +43,7 @@ def __init__(self_, interval: str, max_retries: float, **kwargs): :type interval: str :param max_retries: The ``RetryStrategyLinear`` ``maxRetries``. - :type max_retries: float + :type max_retries: int """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/schedule_trigger_wrapper.py b/src/datadog_api_client/v2/model/schedule_trigger_wrapper.py index fd5e74ddb8..d1be8aae7b 100644 --- a/src/datadog_api_client/v2/model/schedule_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/schedule_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param schedule_trigger: Trigger a workflow from a Schedule. The workflow must be published. :type schedule_trigger: ScheduleTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/security_trigger_wrapper.py b/src/datadog_api_client/v2/model/security_trigger_wrapper.py index b27cb85837..0a9751566a 100644 --- a/src/datadog_api_client/v2/model/security_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/security_trigger_wrapper.py @@ -41,7 +41,7 @@ def __init__( :param security_trigger: Trigger a workflow from a Security Signal or Finding. For automatic triggering a handle must be configured and the workflow must be published. :type security_trigger: SecurityTrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/self_service_trigger_wrapper.py b/src/datadog_api_client/v2/model/self_service_trigger_wrapper.py index 6a7329801b..db6a5f79f8 100644 --- a/src/datadog_api_client/v2/model/self_service_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/self_service_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, self_service_trigger: dict, start_step_names: Union[List[str :param self_service_trigger: Trigger a workflow from Self Service. :type self_service_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/slack_trigger_wrapper.py b/src/datadog_api_client/v2/model/slack_trigger_wrapper.py index 89c74e9f3e..a1e2531b3d 100644 --- a/src/datadog_api_client/v2/model/slack_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/slack_trigger_wrapper.py @@ -33,7 +33,7 @@ def __init__(self_, slack_trigger: dict, start_step_names: Union[List[str], Unse :param slack_trigger: Trigger a workflow from Slack. The workflow must be published. :type slack_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/software_catalog_trigger_wrapper.py b/src/datadog_api_client/v2/model/software_catalog_trigger_wrapper.py index e6139dc22b..45521e72e5 100644 --- a/src/datadog_api_client/v2/model/software_catalog_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/software_catalog_trigger_wrapper.py @@ -35,7 +35,7 @@ def __init__( :param software_catalog_trigger: Trigger a workflow from Software Catalog. :type software_catalog_trigger: dict - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional """ if start_step_names is not unset: diff --git a/src/datadog_api_client/v2/model/spec.py b/src/datadog_api_client/v2/model/spec.py index 3ea379b448..6ab88b75d0 100644 --- a/src/datadog_api_client/v2/model/spec.py +++ b/src/datadog_api_client/v2/model/spec.py @@ -109,7 +109,7 @@ def __init__( **kwargs, ): """ - The spec defines what the workflow does. + 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! :type annotations: [Annotation], optional diff --git a/src/datadog_api_client/v2/model/step.py b/src/datadog_api_client/v2/model/step.py index 3e5713a30e..a5afbe0d00 100644 --- a/src/datadog_api_client/v2/model/step.py +++ b/src/datadog_api_client/v2/model/step.py @@ -23,6 +23,15 @@ class Step(ModelNormal): + validations = { + "action_id": { + "min_length": 1, + }, + "name": { + "min_length": 1, + }, + } + @cached_property def openapi_types(_): from datadog_api_client.v2.model.completion_gate import CompletionGate @@ -81,7 +90,8 @@ def __init__( :param connection_label: The unique identifier of a connection defined in the spec. :type connection_label: str, optional - :param display: The definition of ``StepDisplay`` object. + :param display: 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. :type display: StepDisplay, optional :param error_handlers: The ``Step`` ``errorHandlers``. @@ -90,7 +100,7 @@ def __init__( :param name: Name of the step. :type name: str - :param outbound_edges: A list of subsequent actions to run. + :param outbound_edges: A list of subsequent actions to run. This list is empty for a terminal step. :type outbound_edges: [OutboundEdge], optional :param parameters: A list of inputs for an action. diff --git a/src/datadog_api_client/v2/model/step_display.py b/src/datadog_api_client/v2/model/step_display.py index 461da0053b..0214c4ba72 100644 --- a/src/datadog_api_client/v2/model/step_display.py +++ b/src/datadog_api_client/v2/model/step_display.py @@ -32,7 +32,8 @@ def openapi_types(_): def __init__(self_, bounds: Union[StepDisplayBounds, UnsetType] = unset, **kwargs): """ - The definition of ``StepDisplay`` object. + 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. :param bounds: The definition of ``StepDisplayBounds`` object. :type bounds: StepDisplayBounds, optional diff --git a/src/datadog_api_client/v2/model/trigger.py b/src/datadog_api_client/v2/model/trigger.py index 1b3fe5a051..cbf7706a2a 100644 --- a/src/datadog_api_client/v2/model/trigger.py +++ b/src/datadog_api_client/v2/model/trigger.py @@ -18,7 +18,7 @@ def __init__(self, **kwargs): :param api_trigger: Trigger a workflow from an API request. The workflow must be published. :type api_trigger: APITrigger - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional :param app_trigger: Trigger a workflow from an App. @@ -72,7 +72,7 @@ def __init__(self, **kwargs): :param software_catalog_trigger: Trigger a workflow from Software Catalog. :type software_catalog_trigger: dict - :param workflow_trigger: Trigger a workflow from the Datadog UI. Only required if no other trigger exists. + :param workflow_trigger: Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger. :type workflow_trigger: dict """ super().__init__(kwargs) diff --git a/src/datadog_api_client/v2/model/workflow_data_attributes.py b/src/datadog_api_client/v2/model/workflow_data_attributes.py index 9328943e86..55b7b19214 100644 --- a/src/datadog_api_client/v2/model/workflow_data_attributes.py +++ b/src/datadog_api_client/v2/model/workflow_data_attributes.py @@ -76,7 +76,7 @@ def __init__( :param published: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. :type published: bool, optional - :param spec: The spec defines what the workflow does. + :param spec: A complete Workflow Automation definition, including its triggers, steps, and connections. :type spec: Spec :param tags: Tags of the workflow. diff --git a/src/datadog_api_client/v2/model/workflow_data_update_attributes.py b/src/datadog_api_client/v2/model/workflow_data_update_attributes.py index 46216bba0b..4b4f5bb68e 100644 --- a/src/datadog_api_client/v2/model/workflow_data_update_attributes.py +++ b/src/datadog_api_client/v2/model/workflow_data_update_attributes.py @@ -76,7 +76,7 @@ def __init__( :param published: Set the workflow to published or unpublished. Workflows in an unpublished state will only be executable via manual runs. Automatic triggers such as Schedule will not execute the workflow until it is published. :type published: bool, optional - :param spec: The spec defines what the workflow does. + :param spec: A complete Workflow Automation definition, including its triggers, steps, and connections. :type spec: Spec, optional :param tags: Tags of the workflow. diff --git a/src/datadog_api_client/v2/model/workflow_list_item_attributes.py b/src/datadog_api_client/v2/model/workflow_list_item_attributes.py index b62d126afc..768f6bf4ee 100644 --- a/src/datadog_api_client/v2/model/workflow_list_item_attributes.py +++ b/src/datadog_api_client/v2/model/workflow_list_item_attributes.py @@ -73,7 +73,7 @@ def __init__( :param published: Whether the workflow is published. Unpublished workflows can only be run manually. Automatic triggers such as Schedule do not fire until the workflow is published. :type published: bool, optional - :param spec: The spec defines what the workflow does. + :param spec: A complete Workflow Automation definition, including its triggers, steps, and connections. :type spec: Spec, optional :param tags: Tags of the workflow. diff --git a/src/datadog_api_client/v2/model/workflow_trigger_wrapper.py b/src/datadog_api_client/v2/model/workflow_trigger_wrapper.py index 202b82a3f7..2d9c42a7bf 100644 --- a/src/datadog_api_client/v2/model/workflow_trigger_wrapper.py +++ b/src/datadog_api_client/v2/model/workflow_trigger_wrapper.py @@ -30,10 +30,10 @@ def __init__(self_, workflow_trigger: dict, start_step_names: Union[List[str], U """ Schema for a Workflow-based trigger. - :param start_step_names: A list of steps that run first after a trigger fires. + :param start_step_names: Names of existing workflow steps that run first after a trigger fires. :type start_step_names: [str], optional - :param workflow_trigger: Trigger a workflow from the Datadog UI. Only required if no other trigger exists. + :param workflow_trigger: Trigger a workflow from the Datadog UI. When present, this must be the workflow's only trigger. :type workflow_trigger: dict """ if start_step_names is not unset: