8000 Regenerate client from commit ebc62299 of spec repo · DataDog/documentation@938c27b · GitHub
[go: up one dir, main page]
Skip to content

Commit 938c27b

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit ebc62299 of spec repo
1 parent 8666895 commit 938c27b

File tree

6 files changed

+1880
-76
lines changed

6 files changed

+1880
-76
lines changed

‎.apigentools-info

Lines changed: 4 additions & 4 deletions
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:37:06.898458",
8-
"spec_repo_commit": "4b632dba"
7+
"regenerated": "2025-05-09 00:35:54.809774",
8+
"spec_repo_commit": "ebc62299"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2025-05-08 14:37:16.408460",
13-
"spec_repo_commit": "4b632dba"
12+
"regenerated": "2025-05-09 00:36:04.171646",
13+
"spec_repo_commit": "ebc62299"
1414
}
1515
}
1616
}

‎content/en/api/v2/events/examples.json

Lines changed: 12 additions & 6 deletions
Large diffs are not rendered by default.

‎data/api/v2/full_spec.yaml

Lines changed: 161 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -2165,6 +2165,89 @@ components:
21652165
- id
21662166
- base_severity
21672167
type: object
2168+
AlertEventCustomAttributes:
2169+
additionalProperties: false
2170+
description: Object representing custom alert event attributes.
2171+
properties:
2172+
custom:
2173+
$ref: '#/components/schemas/AlertEventCustomAttributesCustom'
2174+
links:
2175+
$ref: '#/components/schemas/AlertEventCustomAttributesLinks'
2176+
priority:
2177+
$ref: '#/components/schemas/AlertEventCustomAttributesPriority'
2178+
status:
2179+
$ref: '#/components/schemas/AlertEventCustomAttributesStatus'
2180+
type: object
2181+
AlertEventCustomAttributesCustom:
2182+
additionalProperties: {}
2183+
description: Custom attributes support up to 100 properties and a maximum nesting
2184+
depth of 10 levels.
2185+
example: {}
2186+
type: object
2187+
AlertEventCustomAttributesLinks:
2188+
description: The links related to the event.
2189+
items:
2190+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
2191+
maxItems: 20
2192+
minItems: 1
2193+
type: array
2194+
AlertEventCustomAttributesLinksItems:
2195+
description: A link.
2196+
properties:
2197+
category:
2198+
$ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
2199+
title:
2200+
description: The title of the link.
2201+
example: Runbook Link
2202+
maxLength: 300
2203+
type: string
2204+
url:
2205+
description: The URL of the link.
2206+
example: https://app.datadoghq.com/runbook
2207+
maxLength: 2048
2208+
type: string
2209+
required:
2210+
- url
2211+
- category
2212+
type: object
2213+
AlertEventCustomAttributesLinksItemsCategory:
2214+
description: The category of the link.
2215+
enum:
2216+
- runbook
2217+
example: runbook
2218+
type: string
2219+
x-enum-varnames:
2220+
- RUNBOOK
2221+
AlertEventCustomAttributesPriority:
2222+
description: The priority of the alert.
2223+
enum:
2224+
- '1'
2225+
- '2'
2226+
- '3'
2227+
- '4'
2228+
- '5'
2229+
example: '1'
2230+
type: string
2231+
x-enum-varnames:
2232+
- PRIORITY_ONE
2233+
- PRIORITY_TWO
2234+
- PRIORITY_THREE
2235+
- PRIORITY_FOUR
2236+
- PRIORITY_FIVE
2237+
AlertEventCustomAttributesStatus:
2238+
description: The status of the alert.
2239+
enum:
2240+
- info
2241+
- warn
2242+
- error
2243+
- ok
2244+
example: warn
2245+
type: string
2246+
x-enum-varnames:
2247+
- INFO
2248+
- WARN
2249+
- ERROR
2250+
- OK
21682251
Annotation:
21692252
description: A list of annotations used in the workflow. These are like sticky
21702253
notes for your workflow!
@@ -13784,28 +13867,34 @@ components:
1378413867
type: string
1378513868
type: object
1378613869
EventCategory:
13787-
description: Event category to identify the type of event. Only the value `change`
13788-
is supported. Support for other categories are coming. please reach out to
13789-
datadog support if you're interested.
13870+
description: Event category to identify the type of event. For example, `change`
13871+
or `alert`.
1379013872
enum:
1379113873
- change
13874+
- alert
1379213875
example: change
1379313876
type: string
1379413877
x-enum-varnames:
1379513878
- CHANGE
13879+
- ALERT
1379613880
EventCreateRequest:
1379713881
description: Object representing an event creation request.
1379813882
properties:
1379913883
attributes:
1380013884
$ref: '#/components/schemas/EventPayload'
1380113885
type:
1380213886
$ref: '#/components/schemas/EventCreateRequestType'
13887+
required:
13888+
- type
13889+
- attributes
1380313890
type: object
1380413891
EventCreateRequestPayload:
1380513892
description: Payload for creating an event.
1380613893
properties:
1380713894
data:
1380813895
$ref: '#/components/schemas/EventCreateRequest'
13896+
required:
13897+
- data
1380913898
type: object
1381013899
EventCreateRequestType:
1381113900
description: Entity type.
@@ -13820,6 +13909,12 @@ components:
1382013909
properties:
1382113910
attributes:
1382213911
$ref: '#/components/schemas/EventCreateResponseAttributes'
13912+
id:
13913+
description: A numerical ID compatible with the V1 endpoint. This field
13914+
is not populated in response from the V2 endpoint. To retrieve this ID,
13915+
refer to the event attributes in the Event Explorer.
13916+
example: _
13917+
type: string
1382313918
type:
1382413919
description: Event type
1382513920
example: event
@@ -13841,28 +13936,48 @@ components:
1384113936
EventCreateResponseAttributesAttributesEvt:
1384213937
description: JSON object of event system attributes.
1384313938
properties:
13844-
id:
13845-
description: Event id
13939+
uid:
13940+
description: A unique identifier for the event. You can use this ID to query
13941+
or reference the event in the V2 endpoint.
13942+
example: ABCDEFGHIJKLMNOPQRSTUVWX
1384613943
type: string
1384713944
type: object
1384813945
EventCreateResponsePayload:
1384913946
description: Response containing information about created event.
1385013947
properties:
1385113948
data:
1385213949
$ref: '#/components/schemas/EventCreateResponse'
13950+
links:
13951+
$ref: '#/components/schemas/EventCreateResponsePayloadLinks'
13952+
type: object
13953+
EventCreateResponsePayloadLinks:
13954+
description: Links attributes.
13955+
properties:
13956+
self:
13957+
description: The URL of the event. This link is only functional when using
13958+
the `app` subdomain.
13959+
example: https://app.datadoghq.com/event/event?id=123
13960+
type: string
1385313961
type: object
1385413962
EventPayload:
1385513963
description: Event attributes.
1385613964
properties:
1385713965
aggregation_key:
1385813966
description: An arbitrary string to use for aggregation when correlating
1385913967
events. Limited to 100 characters.
13968+
example: aggregation_key_123
1386013969
maxLength: 100
1386113970
type: string
1386213971
attributes:
1386313972
$ref: '#/components/schemas/EventPayloadAttributes'
1386413973
category:
1386513974
$ref: '#/components/schemas/EventCategory'
13975+
integration_id:
13976+
description: Integration IDs sourced from manifests. Examples include custom-events,
13977+
containerd, docker, elasticsearch, helm, mongodb, mysql, and nagios. See
13978+
the full list of available IDs [here](https://docs.datadoghq.com/service_management/events/ingest/integration_ids).
13979+
example: custom-events
13980+
type: string
1386613981
message:
1386713982
description: The body of the event. Limited to 4000 characters.
1386813983
example: payment_processed feature flag has been enabled
@@ -13876,7 +13991,10 @@ components:
1387613991
- env:test
1387713992
items:
1387813993
description: A tag.
13994+
maxLength: 200
1387913995
type: string
13996+
maxItems: 100
13997+
minItems: 1
1388013998
type: array
1388113999
timestamp:
1388214000
description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -13902,6 +14020,7 @@ components:
1390214020
event category.
1390314021
oneOf:
1390414022
- $ref: '#/components/schemas/ChangeEventCustomAttributes'
14023+
- $ref: '#/components/schemas/AlertEventCustomAttributes'
1390514024
EventPriority:
1390614025
description: The priority of the event's monitor. For example, `normal` or `low`.
1390714026
enum:
@@ -46770,7 +46889,8 @@ paths:
4677046889
type: safe
4677146890
post:
4677246891
description: "This endpoint allows you to post events.\n\n\u2705 **Only events
46773-
with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
46892+
with the `change` or `alert` category** are in General Availability. For change
46893+
events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
4677446894
for more details.\n\n\u274C For use cases involving other event categories,
4677546895
please use the V1 endpoint."
4677646896
operationId: CreateEvent
@@ -46782,6 +46902,7 @@ paths:
4678246902
value:
4678346903
data:
4678446904
attributes:
46905+
aggregation_key: aggregation_key_123
4678546906
attributes:
4678646907
author:
4678746908
name: datadog@datadog.com
@@ -46810,6 +46931,7 @@ paths:
4681046931
rule:
4681146932
datacenter: devcycle.us1.prod
4681246933
category: change
46934+
integration_id: custom-events
4681346935
message: payment_processed feature flag has been enabled
4681446936
tags:
4681546937
- env:test
@@ -46820,7 +46942,7 @@ paths:
4682046942
description: Event request object
4682146943
required: true
4682246944
responses:
46823-
'200':
46945+
'202':
4682446946
content:
4682546947
application/json:
4682646948
schema:
@@ -46843,6 +46965,38 @@ paths:
4684346965
security:
4684446966
- apiKeyAuth: []
4684546967
appKeyAuth: []
46968+
servers:
46969+
- url: https://{subdomain}.{site}
46970+
variables:
46971+
site:
46972+
default: datadoghq.com
46973+
description: The regional site for customers.
46974+
enum:
46975+
- datadoghq.com
46976+
- us3.datadoghq.com
46977+
- us5.datadoghq.com
46978+
- ap1.datadoghq.com
46979+
- datadoghq.eu
46980+
- ddog-gov.com
46981+
subdomain:
46982+
default: event-management-intake
46983+
description: The subdomain where the API is deployed.
46984+
- url: '{protocol}://{name}'
46985+
variables:
46986+
name:
46987+
default: event-management-intake.datadoghq.com
46988+
description: Full site DNS name.
46989+
protocol:
46990+
default: https
46991+
description: The protocol for accessing the API.
46992+
- url: https://{subdomain}.{site}
46993+
variables:
46994+
site:
46995+
default: datadoghq.com
46996+
description: Any Datadog deployment.
46997+
subdomain:
46998+
default: event-management-intake
46999+
description: The subdomain where the API is deployed.
4684647000
summary: Post an event
4684747001
tags:
4684847002
- Events

0 commit comments

Comments
 (0)
0