Skip to content

Commit aaf4842

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ebc62299 of spec repo
1 parent 8a4b904 commit aaf4842

22 files changed

+707
-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-05-08 14:34:53.291523",
8-
"spec_repo_commit": "4b632dba"
7+
"regenerated": "2025-05-09 00:33:51.149225",
8+
"spec_repo_commit": "ebc62299"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-08 14:34:53.311445",
13-
"spec_repo_commit": "4b632dba"
12+
"regenerated": "2025-05-09 00:33:51.320960",
13+
"spec_repo_commit": "ebc62299"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

+161-7
Original file line numberDiff line numberDiff line change
@@ -2138,6 +2138,89 @@ components:
21382138
- id
21392139
- base_severity
21402140
type: object
2141+
AlertEventCustomAttributes:
2142+
additionalProperties: false
2143+
description: Object representing custom alert event attributes.
2144+
properties:
2145+
custom:
2146+
$ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2147+
links:
2148+
$ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2149+
priority:
2150+
$ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2151+
status:
2152+
$ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2153+
type: object
2154+
AlertEventCustomAttributesCustom:
2155+
additionalProperties: {}
2156+
description: Custom attributes support up to 100 properties and a maximum nesting
2157+
depth of 10 levels.
2158+
example: {}
2159+
type: object
2160+
AlertEventCustomAttributesLinks:
2161+
description: The links related to the event.
2162+
items:
2163+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2164+
maxItems: 20
2165+
minItems: 1
2166+
type: array
2167+
AlertEventCustomAttributesLinksItems:
2168+
description: A link.
2169+
properties:
2170+
category:
2171+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2172+
title:
2173+
description: The title of the link.
2174+
example: Runbook Link
2175+
maxLength: 300
2176+
type: string
2177+
url:
2178+
description: The URL of the link.
2179+
example: https://app.datadoghq.com/runbook
2180+
maxLength: 2048
2181+
type: string
2182+
required:
2183+
- url
2184+
- category
2185+
type: object
2186+
AlertEventCustomAttributesLinksItemsCategory:
2187+
description: The category of the link.
2188+
enum:
2189+
- runbook
2190+
example: runbook
2191+
type: string
2192+
x-enum-varnames:
2193+
- RUNBOOK
2194+
AlertEventCustomAttributesPriority:
2195+
description: The priority of the alert.
2196+
enum:
2197+
- '1'
2198+
- '2'
2199+
- '3'
2200+
- '4'
2201+
- '5'
2202+
example: '1'
2203+
type: string
2204+
x-enum-varnames:
2205+
- PRIORITY_ONE
2206+
- PRIORITY_TWO
2207+
- PRIORITY_THREE
2208+
- PRIORITY_FOUR
2209+
- PRIORITY_FIVE
2210+
AlertEventCustomAttributesStatus:
2211+
description: The status of the alert.
2212+
enum:
2213+
- info
2214+
- warn
2215+
- error
2216+
- ok
2217+
example: warn
2218+
type: string
2219+
x-enum-varnames:
2220+
- INFO
2221+
- WARN
2222+
- ERROR
2223+
- OK
21412224
Annotation:
21422225
description: A list of annotations used in the workflow. These are like sticky
21432226
notes for your workflow!
@@ -13904,28 +13987,34 @@ components:
1390413987
type: string
1390513988
type: object
1390613989
EventCategory:
13907-
description: Event category to identify the type of event. Only the value `change`
13908-
is supported. Support for other categories are coming. please reach out to
13909-
datadog support if you're interested.
13990+
description: Event category to identify the type of event. For example, `change`
13991+
or `alert`.
1391013992
enum:
1391113993
- change
13994+
- alert
1391213995
example: change
1391313996
type: string
1391413997
x-enum-varnames:
1391513998
- CHANGE
13999+
- ALERT
1391614000
EventCreateRequest:
1391714001
description: Object representing an event creation request.
1391814002
properties:
1391914003
attributes:
1392014004
$ref: '#/components/schemas/EventPayload'
1392114005
type:
1392214006
$ref: '#/components/schemas/EventCreateRequestType'
14007+
required:
14008+
- type
14009+
- attributes
1392314010
type: object
1392414011
EventCreateRequestPayload:
1392514012
description: Payload for creating an event.
1392614013
properties:
1392714014
data:
1392814015
$ref: '#/components/schemas/EventCreateRequest'
14016+
required:
14017+
- data
1392914018
type: object
1393014019
EventCreateRequestType:
1393114020
description: Entity type.
@@ -13940,6 +14029,12 @@ components:
1394014029
properties:
1394114030
attributes:
1394214031
$ref: '#/components/schemas/EventCreateResponseAttributes'
14032+
id:
14033+
description: A numerical ID compatible with the V1 endpoint. This field
14034+
is not populated in response from the V2 endpoint. To retrieve this ID,
14035+
refer to the event attributes in the Event Explorer.
14036+
example: _
14037+
type: string
1394314038
type:
1394414039
description: Event type
1394514040
example: event
@@ -13961,28 +14056,48 @@ components:
1396114056
EventCreateResponseAttributesAttributesEvt:
1396214057
description: JSON object of event system attributes.
1396314058
properties:
13964-
id:
13965-
description: Event id
14059+
uid:
14060+
description: A unique identifier for the event. You can use this ID to query
14061+
or reference the event in the V2 endpoint.
14062+
example: ABCDEFGHIJKLMNOPQRSTUVWX
1396614063
type: string
1396714064
type: object
1396814065
EventCreateResponsePayload:
1396914066
description: Response containing information about created event.
1397014067
properties:
1397114068
data:
1397214069
$ref: '#/components/schemas/EventCreateResponse'
14070+
links:
14071+
$ref: '#/components/schemas/EventCreateResponsePayloadLinks'
14072+
type: object
14073+
EventCreateResponsePayloadLinks:
14074+
description: Links attributes.
14075+
properties:
14076+
self:
14077+
description: The URL of the event. This link is only functional when using
14078+
the `app` subdomain.
14079+
example: https://app.datadoghq.com/event/event?id=123
14080+
type: string
1397314081
type: object
1397414082
EventPayload:
1397514083
description: Event attributes.
1397614084
properties:
1397714085
aggregation_key:
1397814086
description: An arbitrary string to use for aggregation when correlating
1397914087
events. Limited to 100 characters.
14088+
example: aggregation_key_123
1398014089
maxLength: 100
1398114090
type: string
1398214091
attributes:
1398314092
$ref: '#/components/schemas/EventPayloadAttributes'
1398414093
category:
1398514094
$ref: '#/components/schemas/EventCategory'
14095+
integration_id:
14096+
description: Integration IDs sourced from manifests. Examples include custom-events,
14097+
containerd, docker, elasticsearch, helm, mongodb, mysql, and nagios. See
14098+
the full list of available IDs [here](https://docs.datadoghq.com/service_management/events/ingest/integration_ids).
14099+
example: custom-events
14100+
type: string
1398614101
message:
1398714102
description: The body of the event. Limited to 4000 characters.
1398814103
example: payment_processed feature flag has been enabled
@@ -13996,7 +14111,10 @@ components:
1399614111
- env:test
1399714112
items:
1399814113
description: A tag.
14114+
maxLength: 200
1399914115
type: string
14116+
maxItems: 100
14117+
minItems: 1
1400014118
type: array
1400114119
timestamp:
1400214120
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14022,6 +14140,7 @@ components:
1402214140
event category.
1402314141
oneOf:
1402414142
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14143+
- $ref: '#/components/schemas/AlertEventCustomAttributes'
1402514144
EventPriority:
1402614145
description: The priority of the event's monitor. For example, `normal` or `low`.
1402714146
enum:
@@ -45640,7 +45759,8 @@ paths:
4564045759
- events_read
4564145760
post:
4564245761
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
45643-
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
45762+
with the `change` or `alert` category** are in General Availability. For change
45763+
events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
4564445764
for more details.\n\n\u274C For use cases involving other event categories,
4564545765
please use the V1 endpoint."
4564645766
operationId: CreateEvent
@@ -45652,6 +45772,7 @@ paths:
4565245772
value:
4565345773
data:
4565445774
attributes:
45775+
aggregation_key: aggregation_key_123
4565545776
attributes:
4565645777
author:
4565745778
@@ -45680,6 +45801,7 @@ paths:
4568045801
rule:
4568145802
datacenter: devcycle.us1.prod
4568245803
category: change
45804+
integration_id: custom-events
4568345805
message: payment_processed feature flag has been enabled
4568445806
tags:
4568545807
- env:test
@@ -45690,7 +45812,7 @@ paths:
4569045812
description: Event request object
4569145813
required: true
4569245814
responses:
45693-
'200':
45815+
'202':
4569445816
content:
4569545817
application/json:
4569645818
schema:
@@ -45713,6 +45835,38 @@ paths:
4571345835
security:
4571445836
- apiKeyAuth: []
4571545837
appKeyAuth: []
45838+
servers:
45839+
- url: https://{subdomain}.{site}
45840+
variables:
45841+
site:
45842+
default: datadoghq.com
45843+
description: The regional site for customers.
45844+
enum:
45845+
- datadoghq.com
45846+
- us3.datadoghq.com
45847+
- us5.datadoghq.com
45848+
- ap1.datadoghq.com
45849+
- datadoghq.eu
45850+
- ddog-gov.com
45851+
subdomain:
45852+
default: event-management-intake
45853+
description: The subdomain where the API is deployed.
45854+
- url: '{protocol}://{name}'
45855+
variables:
45856+
name:
45857+
default: event-management-intake.datadoghq.com
45858+
description: Full site DNS name.
45859+
protocol:
45860+
default: https
45861+
description: The protocol for accessing the API.
45862+
- url: https://{subdomain}.{site}
45863+
variables:
45864+
site:
45865+
default: datadoghq.com
45866+
description: Any Datadog deployment.
45867+
subdomain:
45868+
default: event-management-intake
45869+
description: The subdomain where the API is deployed.
4571645870
summary: Post an event
4571745871
tags:
4571845872
- Events

docs/datadog_api_client.v2.model.rst

+49
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,48 @@ datadog\_api\_client.v2.model.advisory module
214214
:members:
215215
:show-inheritance:
216216

217+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes module
218+
---------------------------------------------------------------------
219+
220+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes
221+
:members:
222+
:show-inheritance:
223+
224+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_custom module
225+
-----------------------------------------------------------------------------
226+
227+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_custom
228+
:members:
229+
:show-inheritance:
230+
231+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_links\_items module
232+
-----------------------------------------------------------------------------------
233+
234+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_links_items
235+
:members:
236+
:show-inheritance:
237+
238+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_links\_items\_category module
239+
---------------------------------------------------------------------------------------------
240+
241+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_links_items_category
242+
:members:
243+
:show-inheritance:
244+
245+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_priority module
246+
-------------------------------------------------------------------------------
247+
248+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_priority
249+
:members:
250+
:show-inheritance:
251+
252+
datadog\_api\_client.v2.model.alert\_event\_custom\_attributes\_status module
253+
-----------------------------------------------------------------------------
254+
255+
.. automodule:: datadog_api_client.v2.model.alert_event_custom_attributes_status
256+
:members:
257+
:show-inheritance:
258+
217259
datadog\_api\_client.v2.model.annotation module
218260
-----------------------------------------------
219261

@@ -5723,6 +5765,13 @@ datadog\_api\_client.v2.model.event\_create\_response\_payload module
57235765
:members:
57245766
:show-inheritance:
57255767

5768+
datadog\_api\_client.v2.model.event\_create\_response\_payload\_links module
5769+
----------------------------------------------------------------------------
5770+
5771+
.. automodule:: datadog_api_client.v2.model.event_create_response_payload_links
5772+
:members:
5773+
:show-inheritance:
5774+
57265775
datadog\_api\_client.v2.model.event\_payload module
57275776
---------------------------------------------------
57285777

examples/v2/events/CreateEvent.py

+2
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,7 @@
2828
body = EventCreateRequestPayload(
2929
data=EventCreateRequest(
3030
attributes=EventPayload(
31+
aggregation_key="aggregation_key_123",
3132
attributes=ChangeEventCustomAttributes(
3233
author=ChangeEventCustomAttributesAuthor(
3334
@@ -60,6 +61,7 @@
6061
),
6162
),
6263
category=EventCategory.CHANGE,
64+
integration_id="custom-events",
6365
message="payment_processed feature flag has been enabled",
6466
tags=[
6567
"env:test",

0 commit comments

Comments
 (0)