Skip to content

Commit 193f9f7

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
and
ci.datadog-api-spec
authored
Add more triggers for workflow automation (#2471)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent f4c44ea commit 193f9f7

29 files changed

+337
-49
lines changed

.apigentools-info

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.6",
7-
"regenerated": "2025-03-24 17:12:23.541972",
8-
"spec_repo_commit": "764de5f0"
7+
"regenerated": "2025-03-25 18:26:21.124240",
8+
"spec_repo_commit": "b25d7c85"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-03-24 17:12:23.660221",
13-
"spec_repo_commit": "764de5f0"
12+
"regenerated": "2025-03-25 18:26:21.139311",
13+
"spec_repo_commit": "b25d7c85"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+62-14
Original file line numberDiff line numberDiff line change
@@ -1095,7 +1095,7 @@ components:
10951095
x-enum-varnames:
10961096
- API_KEYS
10971097
APITrigger:
1098-
description: Trigger a workflow VIA an API. The workflow must be published.
1098+
description: Trigger a workflow from an API request. The workflow must be published.
10991099
properties:
11001100
rateLimit:
11011101
$ref: '#/components/schemas/TriggerRateLimit'
@@ -2313,7 +2313,7 @@ components:
23132313
description: Schema for an App-based trigger.
23142314
properties:
23152315
appTrigger:
2316-
description: Trigger a workflow VIA an App.
2316+
description: Trigger a workflow from an App.
23172317
type: object
23182318
startStepNames:
23192319
$ref: '#/components/schemas/StartStepNames'
@@ -6525,7 +6525,7 @@ components:
65256525
- IN_PROGRESS
65266526
- CLOSED
65276527
CaseTrigger:
6528-
description: Trigger a workflow VIA a Case. For automatic triggering a handle
6528+
description: Trigger a workflow from a Case. For automatic triggering a handle
65296529
must be configured and the workflow must be published.
65306530
properties:
65316531
rateLimit:
@@ -6762,7 +6762,7 @@ components:
67626762
description: Schema for a Change Event-based trigger.
67636763
properties:
67646764
changeEventTrigger:
6765-
description: Trigger a workflow VIA a Change Event.
6765+
description: Trigger a workflow from a Change Event.
67666766
type: object
67676767
startStepNames:
67686768
$ref: '#/components/schemas/StartStepNames'
@@ -10589,7 +10589,7 @@ components:
1058910589
description: Schema for a Dashboard-based trigger.
1059010590
properties:
1059110591
dashboardTrigger:
10592-
description: Trigger a workflow VIA a Dashboard.
10592+
description: Trigger a workflow from a Dashboard.
1059310593
type: object
1059410594
startStepNames:
1059510595
$ref: '#/components/schemas/StartStepNames'
@@ -10813,6 +10813,17 @@ components:
1081310813
type: string
1081410814
x-enum-varnames:
1081510815
- DATATRANSFORM
10816+
DatabaseMonitoringTriggerWrapper:
10817+
description: Schema for a Database Monitoring-based trigger.
10818+
properties:
10819+
databaseMonitoringTrigger:
10820+
description: Trigger a workflow from Database Monitoring.
10821+
type: object
10822+
startStepNames:
10823+
$ref: '#/components/schemas/StartStepNames'
10824+
required:
10825+
- databaseMonitoringTrigger
10826+
type: object
1081610827
Date:
1081710828
description: Date as Unix timestamp in milliseconds.
1081810829
example: 1722439510282
@@ -14393,9 +14404,9 @@ components:
1439314404
example: https://github.com/organization/example-repository
1439414405
type: string
1439514406
GithubWebhookTrigger:
14396-
description: Trigger a workflow VIA GitHub webhook. To trigger a workflow from
14397-
GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings, set
14398-
the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id",
14407+
description: Trigger a workflow from a GitHub webhook. To trigger a workflow
14408+
from GitHub, you must set a `webhookSecret`. In your GitHub Webhook Settings,
14409+
set the Payload URL to "base_url"/api/v2/workflows/"workflow_id"/webhook?orgId="org_id",
1439914410
select application/json for the content type, and be highly recommend enabling
1440014411
SSL verification for security. The workflow must be published.
1440114412
properties:
@@ -16706,7 +16717,7 @@ components:
1670616717
x-enum-varnames:
1670716718
- INCIDENT_TODOS
1670816719
IncidentTrigger:
16709-
description: Trigger a workflow VIA an Incident. For automatic triggering a
16720+
description: Trigger a workflow from an Incident. For automatic triggering a
1671016721
handle must be configured and the workflow must be published.
1671116722
properties:
1671216723
rateLimit:
@@ -21179,7 +21190,7 @@ components:
2117921190
$ref: '#/components/schemas/MonitorDowntimeMatchResourceType'
2118021191
type: object
2118121192
MonitorTrigger:
21182-
description: Trigger a workflow VIA a Monitor. For automatic triggering a handle
21193+
description: Trigger a workflow from a Monitor. For automatic triggering a handle
2118321194
must be configured and the workflow must be published.
2118421195
properties:
2118521196
rateLimit:
@@ -21317,6 +21328,17 @@ components:
2131721328
meta:
2131821329
$ref: '#/components/schemas/MonthlyCostAttributionMeta'
2131921330
type: object
21331+
NotebookTriggerWrapper:
21332+
description: Schema for a Notebook-based trigger.
21333+
properties:
21334+
notebookTrigger:
21335+
description: Trigger a workflow from a Notebook.
21336+
type: object
21337+
startStepNames:
21338+
$ref: '#/components/schemas/StartStepNames'
21339+
required:
21340+
- notebookTrigger
21341+
type: object
2132021342
NotificationRule:
2132121343
description: 'Notification rules allow full control over notifications generated
2132221344
by the various Datadog security products.
@@ -26139,7 +26161,7 @@ components:
2613926161
$ref: '#/components/schemas/ScalarFormulaResponseType'
2614026162
type: object
2614126163
ScheduleTrigger:
26142-
description: Trigger a workflow VIA a Schedule. The workflow must be published.
26164+
description: Trigger a workflow from a Schedule. The workflow must be published.
2614326165
properties:
2614426166
rruleExpression:
2614526167
description: Recurrence rule expression for scheduling.
@@ -28436,7 +28458,7 @@ components:
2843628458
type: string
2843728459
type: object
2843828460
SecurityTrigger:
28439-
description: Trigger a workflow VIA a Security Signal or Finding. For automatic
28461+
description: Trigger a workflow from a Security Signal or Finding. For automatic
2844028462
triggering a handle must be configured and the workflow must be published.
2844128463
properties:
2844228464
rateLimit:
@@ -28475,6 +28497,17 @@ components:
2847528497
required:
2847628498
- trigger_source
2847728499
type: object
28500+
SelfServiceTriggerWrapper:
28501+
description: Schema for a Self Service-based trigger.
28502+
properties:
28503+
selfServiceTrigger:
28504+
description: Trigger a workflow from Self Service.
28505+
type: object
28506+
startStepNames:
28507+
$ref: '#/components/schemas/StartStepNames'
28508+
required:
28509+
- selfServiceTrigger
28510+
type: object
2847828511
SensitiveDataScannerConfigRequest:
2847928512
description: Group reorder request.
2848028513
properties:
@@ -30195,7 +30228,7 @@ components:
3019530228
description: Schema for a Slack-based trigger.
3019630229
properties:
3019730230
slackTrigger:
30198-
description: Trigger a workflow VIA Slack. The workflow must be published.
30231+
description: Trigger a workflow from Slack. The workflow must be published.
3019930232
type: object
3020030233
startStepNames:
3020130234
$ref: '#/components/schemas/StartStepNames'
@@ -30249,6 +30282,17 @@ components:
3024930282
required:
3025030283
- attributes
3025130284
type: object
30285+
SoftwareCatalogTriggerWrapper:
30286+
description: Schema for a Software Catalog-based trigger.
30287+
properties:
30288+
softwareCatalogTrigger:
30289+
description: Trigger a workflow from Software Catalog.
30290+
type: object
30291+
startStepNames:
30292+
$ref: '#/components/schemas/StartStepNames'
30293+
required:
30294+
- softwareCatalogTrigger
30295+
type: object
3025230296
SortDirection:
3025330297
default: desc
3025430298
description: The direction to sort by.
@@ -32108,13 +32152,17 @@ components:
3210832152
- $ref: '#/components/schemas/AppTriggerWrapper'
3210932153
- $ref: '#/components/schemas/CaseTriggerWrapper'
3211032154
- $ref: '#/components/schemas/ChangeEventTriggerWrapper'
32155+
- $ref: '#/components/schemas/DatabaseMonitoringTriggerWrapper'
3211132156
- $ref: '#/components/schemas/DashboardTriggerWrapper'
3211232157
- $ref: '#/components/schemas/GithubWebhookTriggerWrapper'
3211332158
- $ref: '#/components/schemas/IncidentTriggerWrapper'
3211432159
- $ref: '#/components/schemas/MonitorTriggerWrapper'
32160+
- $ref: '#/components/schemas/NotebookTriggerWrapper'
3211532161
- $ref: '#/components/schemas/ScheduleTriggerWrapper'
3211632162
- $ref: '#/components/schemas/SecurityTriggerWrapper'
32163+
- $ref: '#/components/schemas/SelfServiceTriggerWrapper'
3211732164
- $ref: '#/components/schemas/SlackTriggerWrapper'
32165+
- $ref: '#/components/schemas/SoftwareCatalogTriggerWrapper'
3211832166
- $ref: '#/components/schemas/WorkflowTriggerWrapper'
3211932167
TriggerRateLimit:
3212032168
description: Defines a rate limit for a trigger.
@@ -33743,7 +33791,7 @@ components:
3374333791
startStepNames:
3374433792
$ref: '#/components/schemas/StartStepNames'
3374533793
workflowTrigger:
33746-
description: Trigger a workflow VIA the Datadog UI. Only required if no
33794+
description: Trigger a workflow from the Datadog UI. Only required if no
3374733795
other trigger exists.
3374833796
type: object
3374933797
required:

docs/datadog_api_client.v2.model.rst

+28
Original file line numberDiff line numberDiff line change
@@ -4239,6 +4239,13 @@ datadog\_api\_client.v2.model.data\_transform\_type module
42394239
:members:
42404240
:show-inheritance:
42414241

4242+
datadog\_api\_client.v2.model.database\_monitoring\_trigger\_wrapper module
4243+
---------------------------------------------------------------------------
4244+
4245+
.. automodule:: datadog_api_client.v2.model.database_monitoring_trigger_wrapper
4246+
:members:
4247+
:show-inheritance:
4248+
42424249
datadog\_api\_client.v2.model.delete\_app\_response module
42434250
----------------------------------------------------------
42444251

@@ -9195,6 +9202,13 @@ datadog\_api\_client.v2.model.ms\_teams\_integration\_metadata\_teams\_item modu
91959202
:members:
91969203
:show-inheritance:
91979204

9205+
datadog\_api\_client.v2.model.notebook\_trigger\_wrapper module
9206+
---------------------------------------------------------------
9207+
9208+
.. automodule:: datadog_api_client.v2.model.notebook_trigger_wrapper
9209+
:members:
9210+
:show-inheritance:
9211+
91989212
datadog\_api\_client.v2.model.notification\_rule module
91999213
-------------------------------------------------------
92009214

@@ -12359,6 +12373,13 @@ datadog\_api\_client.v2.model.selectors module
1235912373
:members:
1236012374
:show-inheritance:
1236112375

12376+
datadog\_api\_client.v2.model.self\_service\_trigger\_wrapper module
12377+
--------------------------------------------------------------------
12378+
12379+
.. automodule:: datadog_api_client.v2.model.self_service_trigger_wrapper
12380+
:members:
12381+
:show-inheritance:
12382+
1236212383
datadog\_api\_client.v2.model.sensitive\_data\_scanner\_config\_request module
1236312384
------------------------------------------------------------------------------
1236412385

@@ -13255,6 +13276,13 @@ datadog\_api\_client.v2.model.slo\_report\_status\_get\_response\_data module
1325513276
:members:
1325613277
:show-inheritance:
1325713278

13279+
datadog\_api\_client.v2.model.software\_catalog\_trigger\_wrapper module
13280+
------------------------------------------------------------------------
13281+
13282+
.. automodule:: datadog_api_client.v2.model.software_catalog_trigger_wrapper
13283+
:members:
13284+
:show-inheritance:
13285+
1325813286
datadog\_api\_client.v2.model.sort\_direction module
1325913287
----------------------------------------------------
1326013288

src/datadog_api_client/v2/model/api_trigger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def openapi_types(_):
3232

3333
def __init__(self_, rate_limit: Union[TriggerRateLimit, UnsetType] = unset, **kwargs):
3434
"""
35-
Trigger a workflow VIA an API. The workflow must be published.
35+
Trigger a workflow from an API request. The workflow must be published.
3636
3737
:param rate_limit: Defines a rate limit for a trigger.
3838
:type rate_limit: TriggerRateLimit, optional

src/datadog_api_client/v2/model/api_trigger_wrapper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def __init__(self_, api_trigger: APITrigger, start_step_names: Union[List[str],
3636
"""
3737
Schema for an API-based trigger.
3838
39-
:param api_trigger: Trigger a workflow VIA an API. The workflow must be published.
39+
:param api_trigger: Trigger a workflow from an API request. The workflow must be published.
4040
:type api_trigger: APITrigger
4141
4242
:param start_step_names: A list of steps that run first after a trigger fires.

src/datadog_api_client/v2/model/app_trigger_wrapper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self_, app_trigger: dict, start_step_names: Union[List[str], UnsetT
3030
"""
3131
Schema for an App-based trigger.
3232
33-
:param app_trigger: Trigger a workflow VIA an App.
33+
:param app_trigger: Trigger a workflow from an App.
3434
:type app_trigger: dict
3535
3636
:param start_step_names: A list of steps that run first after a trigger fires.

src/datadog_api_client/v2/model/case_trigger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def openapi_types(_):
3232

3333
def __init__(self_, rate_limit: Union[TriggerRateLimit, UnsetType] = unset, **kwargs):
3434
"""
35-
Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
35+
Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
3636
3737
:param rate_limit: Defines a rate limit for a trigger.
3838
:type rate_limit: TriggerRateLimit, optional

src/datadog_api_client/v2/model/case_trigger_wrapper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ def __init__(self_, case_trigger: CaseTrigger, start_step_names: Union[List[str]
3636
"""
3737
Schema for a Case-based trigger.
3838
39-
:param case_trigger: Trigger a workflow VIA a Case. For automatic triggering a handle must be configured and the workflow must be published.
39+
:param case_trigger: Trigger a workflow from a Case. For automatic triggering a handle must be configured and the workflow must be published.
4040
:type case_trigger: CaseTrigger
4141
4242
:param start_step_names: A list of steps that run first after a trigger fires.

src/datadog_api_client/v2/model/change_event_trigger_wrapper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self_, change_event_trigger: dict, start_step_names: Union[List[str
3030
"""
3131
Schema for a Change Event-based trigger.
3232
33-
:param change_event_trigger: Trigger a workflow VIA a Change Event.
33+
:param change_event_trigger: Trigger a workflow from a Change Event.
3434
:type change_event_trigger: dict
3535
3636
:param start_step_names: A list of steps that run first after a trigger fires.

src/datadog_api_client/v2/model/dashboard_trigger_wrapper.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ def __init__(self_, dashboard_trigger: dict, start_step_names: Union[List[str],
3030
"""
3131
Schema for a Dashboard-based trigger.
3232
33-
:param dashboard_trigger: Trigger a workflow VIA a Dashboard.
33+
:param dashboard_trigger: Trigger a workflow from a Dashboard.
3434
:type dashboard_trigger: dict
3535
3636
:param start_step_names: A list of steps that run first after a trigger fires.
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
# Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
2+
# This product includes software developed at Datadog (https://www.datadoghq.com/).
3+
# Copyright 2019-Present Datadog, Inc.
4+
from __future__ import annotations
5+
6+
from typing import List, Union
7+
8+
from datadog_api_client.model_utils import (
9+
ModelNormal,
10+
cached_property,
11+
unset,
12+
UnsetType,
13+
)
14+
15+
16+
class DatabaseMonitoringTriggerWrapper(ModelNormal):
17+
@cached_property
18+
def openapi_types(_):
19+
return {
20+
"database_monitoring_trigger": (dict,),
21+
"start_step_names": ([str],),
22+
}
23+
24+
attribute_map = {
25+
"database_monitoring_trigger": "databaseMonitoringTrigger",
26+
"start_step_names": "startStepNames",
27+
}
28+
29+
def __init__(
30+
self_, database_monitoring_trigger: dict, start_step_names: Union[List[str], UnsetType] = unset, **kwargs
31+
):
32+
"""
33+
Schema for a Database Monitoring-based trigger.
34+
35+
:param database_monitoring_trigger: Trigger a workflow from Database Monitoring.
36+
:type database_monitoring_trigger: dict
37+
38+
:param start_step_names: A list of steps that run first after a trigger fires.
39+
:type start_step_names: [str], optional
40+
"""
41+
if start_step_names is not unset:
42+
kwargs["start_step_names"] = start_step_names
43+
super().__init__(kwargs)
44+
45+
self_.database_monitoring_trigger = database_monitoring_trigger

src/datadog_api_client/v2/model/github_webhook_trigger.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ def openapi_types(_):
3232

3333
def __init__(self_, rate_limit: Union[TriggerRateLimit, UnsetType] = unset, **kwargs):
3434
"""
35-
Trigger a workflow VIA 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.
35+
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.
3636
3737
:param rate_limit: Defines a rate limit for a trigger.
3838
:type rate_limit: TriggerRateLimit, optional

0 commit comments

Comments
 (0)