Skip to content

Commit 163f0e9

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit d5d7664b of spec repo
1 parent fc0a016 commit 163f0e9

24 files changed

+1949
-13
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": "2024-10-09 15:02:58.401855",
8-
"spec_repo_commit": "43ae024c"
7+
"regenerated": "2024-10-10 10:54:36.232049",
8+
"spec_repo_commit": "d5d7664b"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-10-09 15:02:58.419941",
13-
"spec_repo_commit": "43ae024c"
12+
"regenerated": "2024-10-10 10:54:36.249985",
13+
"spec_repo_commit": "d5d7664b"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 258 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3951,6 +3951,226 @@ components:
39513951
format: int64
39523952
type: integer
39533953
type: object
3954+
ChangeEvent:
3955+
description: Object representing a change event.
3956+
properties:
3957+
aggregation_key:
3958+
description: 'An arbitrary string to use for aggregation. Limited to 100
3959+
characters.
3960+
3961+
If you specify a key, all events using that key are grouped together in
3962+
the Event Stream.'
3963+
maxLength: 100
3964+
type: string
3965+
attributes:
3966+
$ref: '#/components/schemas/ChangeEventCustomAttributes'
3967+
category:
3968+
$ref: '#/components/schemas/ChangeEventCategory'
3969+
message:
3970+
description: The body of the event. Limited to 4000 characters.
3971+
example: payment_processed feature flag has been enabled
3972+
maxLength: 4000
3973+
type: string
3974+
tags:
3975+
description: 'A list of tags to apply to the event.
3976+
3977+
Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).'
3978+
example:
3979+
- environment:test
3980+
items:
3981+
description: A tag.
3982+
type: string
3983+
type: array
3984+
timestamp:
3985+
description: 'Timestamp in which the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
3986+
format.
3987+
3988+
For example `"2017-01-15T01:30:15.010000Z"`.
3989+
3990+
Defaults to now. Limited to values no older than 18 hours.'
3991+
type: string
3992+
title:
3993+
description: The event title. Limited to 500 characters.
3994+
example: payment_processed feature flag updated
3995+
maxLength: 500
3996+
type: string
3997+
required:
3998+
- title
3999+
- category
4000+
- attributes
4001+
type: object
4002+
ChangeEventCategory:
4003+
description: Event category to identify the type of event. Only the value `change`
4004+
is supported.
4005+
enum:
4006+
- change
4007+
example: change
4008+
type: string
4009+
x-enum-varnames:
4010+
- CHANGE
4011+
ChangeEventCreateRequest:
4012+
description: Object representing an event.
4013+
properties:
4014+
attributes:
4015+
$ref: '#/components/schemas/ChangeEvent'
4016+
type:
4017+
$ref: '#/components/schemas/ChangeEventCreateRequestType'
4018+
type: object
4019+
ChangeEventCreateRequestType:
4020+
description: Entity type.
4021+
enum:
4022+
- event
4023+
type: string
4024+
x-enum-varnames:
4025+
- EVENT
4026+
ChangeEventCreateResponse:
4027+
description: Object containing an event response.
4028+
properties:
4029+
attributes:
4030+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributes'
4031+
type:
4032+
description: Event type
4033+
type: string
4034+
type: object
4035+
ChangeEventCreateResponseAttributes:
4036+
description: The definition of `ChangeEventCreateResponseAttributes` object.
4037+
properties:
4038+
attributes:
4039+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributes'
4040+
type: object
4041+
ChangeEventCreateResponseAttributesAttributes:
4042+
description: The definition of `ChangeEventCreateResponseAttributesAttributes`
4043+
object.
4044+
properties:
4045+
evt:
4046+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributesEvt'
4047+
type: object
4048+
ChangeEventCreateResponseAttributesAttributesEvt:
4049+
description: The definition of `ChangeEventCreateResponseAttributesAttributesEvt`
4050+
object.
4051+
properties:
4052+
id:
4053+
description: Event id
4054+
type: string
4055+
type: object
4056+
ChangeEventCustomAttributes:
4057+
description: Object representing custom event attributes.
4058+
properties:
4059+
author:
4060+
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
4061+
change_metadata:
4062+
additionalProperties: {}
4063+
description: Free form object with any related information of the `change`
4064+
event.
4065+
example:
4066+
resource_link: /feature/fallback_payments_test
4067+
user:
4068+
email: dd_user_email
4069+
name: dd_user
4070+
type: object
4071+
changed_resource:
4072+
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource'
4073+
impacted_resources:
4074+
description: 'A list of resources impacted by this change. At least one
4075+
resource is required. Only resources
4076+
4077+
of type `service` are supported.'
4078+
example:
4079+
- name: payments_api
4080+
type: service
4081+
items:
4082+
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
4083+
type: array
4084+
new_value:
4085+
additionalProperties: {}
4086+
description: Free form object to track new value of the changed resource.
4087+
example:
4088+
enabled: true
4089+
percentage: 50%
4090+
rule:
4091+
datacenter: us1.prod
4092+
type: object
4093+
prev_value:
4094+
additionalProperties: {}
4095+
description: Free form object to track previous value of the changed resource.
4096+
example:
4097+
enabled: true
4098+
percentage: 10%
4099+
rule:
4100+
datacenter: us1.prod
4101+
type: object
4102+
required:
4103+
- changed_resource
4104+
type: object
4105+
ChangeEventCustomAttributesAuthor:
4106+
description: Object representing the entity which made the change. Optional
4107+
field but if provided should include `type` and `name`.
4108+
properties:
4109+
name:
4110+
description: Author's name. Limited to 128 characters.
4111+
example: user
4112+
maxLength: 128
4113+
type: string
4114+
type:
4115+
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
4116+
required:
4117+
- name
4118+
- type
4119+
type: object
4120+
ChangeEventCustomAttributesAuthorType:
4121+
description: Author's type.
4122+
enum:
4123+
- user
4124+
- system
4125+
example: user
4126+
type: string
4127+
x-enum-varnames:
4128+
- USER
4129+
- SYSTEM
4130+
ChangeEventCustomAttributesChangedResource:
4131+
description: Object representing a uniquely identified resource. Only the resource
4132+
type `feature_flag` is supported.
4133+
properties:
4134+
name:
4135+
description: Resource's name.
4136+
example: fallback_payments_test
4137+
type: string
4138+
type:
4139+
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
4140+
required:
4141+
- type
4142+
- name
4143+
type: object
4144+
ChangeEventCustomAttributesChangedResourceType:
4145+
description: Resource's type.
4146+
enum:
4147+
- feature_flag
4148+
example: feature_flag
4149+
type: string
4150+
x-enum-varnames:
4151+
- FEATURE_FLAG
4152+
ChangeEventCustomAttributesImpactedResourcesItems:
4153+
description: Object representing a uniquely identified resource. Only the resource
4154+
type `service` is supported.
4155+
properties:
4156+
name:
4157+
description: Resource's name.
4158+
example: payments_api
4159+
type: string
4160+
type:
4161+
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
4162+
required:
4163+
- type
4164+
- name
4165+
type: object
4166+
ChangeEventCustomAttributesImpactedResourcesItemsType:
4167+
description: Resource's type.
4168+
enum:
4169+
- service
4170+
example: service
4171+
type: string
4172+
x-enum-varnames:
4173+
- SERVICE
39544174
ChargebackBreakdown:
39554175
description: Charges breakdown.
39564176
properties:
@@ -29664,6 +29884,44 @@ paths:
2966429884
operator: OR
2966529885
permissions:
2966629886
- events_read
29887+
post:
29888+
description: This endpoint allows you to post events. Only events with `change`
29889+
category are supported.
29890+
operationId: CreateEvent
29891+
requestBody:
29892+
content:
29893+
application/json:
29894+
schema:
29895+
$ref: '#/components/schemas/ChangeEventCreateRequest'
29896+
description: Event request object
29897+
required: true
29898+
responses:
29899+
'200':
29900+
content:
29901+
application/json:
29902+
schema:
29903+
$ref: '#/components/schemas/ChangeEventCreateResponse'
29904+
description: OK
29905+
'400':
29906+
content:
29907+
application/json:
29908+
schema:
29909+
$ref: '#/components/schemas/JSONAPIErrorResponse'
29910+
description: Bad request
29911+
'403':
29912+
content:
29913+
application/json:
29914+
schema:
29915+
$ref: '#/components/schemas/JSONAPIErrorResponse'
29916+
description: Forbidden
29917+
'429':
29918+
$ref: '#/components/responses/TooManyRequestsResponse'
29919+
security:
29920+
- apiKeyAuth: []
29921+
summary: Post a change event
29922+
tags:
29923+
- Events
29924+
x-codegen-request-body-name: body
2966729925
/api/v2/events/search:
2966829926
post:
2966929927
description: 'List endpoint returns events that match an events search query.

examples/v2/events/CreateEvent.rb

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
# Post a change event returns "OK" response
2+
3+
require "datadog_api_client"
4+
api_instance = DatadogAPIClient::V2::EventsAPI.new
5+
6+
body = DatadogAPIClient::V2::ChangeEventCreateRequest.new({
7+
attributes: DatadogAPIClient::V2::ChangeEvent.new({
8+
attributes: DatadogAPIClient::V2::ChangeEventCustomAttributes.new({
9+
author: DatadogAPIClient::V2::ChangeEventCustomAttributesAuthor.new({
10+
name: "user",
11+
type: DatadogAPIClient::V2::ChangeEventCustomAttributesAuthorType::USER,
12+
}),
13+
change_metadata: {
14+
"resource_link": "/feature/fallback_payments_test", "user": "{'email': 'dd_user_email', 'name': 'dd_user'}",
15+
},
16+
changed_resource: DatadogAPIClient::V2::ChangeEventCustomAttributesChangedResource.new({
17+
name: "fallback_payments_test",
18+
type: DatadogAPIClient::V2::ChangeEventCustomAttributesChangedResourceType::FEATURE_FLAG,
19+
}),
20+
impacted_resources: [
21+
DatadogAPIClient::V2::ChangeEventCustomAttributesImpactedResourcesItems.new({
22+
name: "payments_api",
23+
type: DatadogAPIClient::V2::ChangeEventCustomAttributesImpactedResourcesItemsType::SERVICE,
24+
}),
25+
],
26+
new_value: {
27+
"enabled": "True", "percentage": "50%", "rule": "{'datacenter': 'us1.prod'}",
28+
},
29+
prev_value: {
30+
"enabled": "True", "percentage": "10%", "rule": "{'datacenter': 'us1.prod'}",
31+
},
32+
}),
33+
category: DatadogAPIClient::V2::ChangeEventCategory::CHANGE,
34+
message: "payment_processed feature flag has been enabled",
35+
tags: [
36+
"environment:test",
37+
],
38+
title: "payment_processed feature flag updated",
39+
}),
40+
type: DatadogAPIClient::V2::ChangeEventCreateRequestType::EVENT,
41+
})
42+
p api_instance.create_event(body)

features/scenarios_model_mapping.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1224,6 +1224,9 @@
12241224
"page_cursor" => "String",
12251225
"page_limit" => "Integer",
12261226
},
1227+
"v2.CreateEvent" => {
1228+
"body" => "ChangeEventCreateRequest",
1229+
},
12271230
"v2.SearchEvents" => {
12281231
"body" => "EventsListRequest",
12291232
},

features/v1/given.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -166,7 +166,7 @@
166166
"parameters": [
167167
{
168168
"name": "body",
169-
"value": "{\n \"name\": \"{{ unique }}\",\n \"type\": \"log alert\",\n \"query\": \"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\n \"message\": \"some message Notify: @hipchat-channel\",\n \"tags\": [\"test:{{ unique_lower_alnum }}\", \"env:ci\"],\n \"priority\": 3,\n \"options\": {\n \"enable_logs_sample\": true,\n \"escalation_message\": \"the situation has escalated\",\n \"evaluation_delay\": 700,\n \"groupby_simple_monitor\": true,\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 600,\n \"no_data_timeframe\": null,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60,\n \"require_full_window\": true,\n \"timeout_h\": 24,\n \"thresholds\": { \"critical\": 2, \"warning\": 1 }\n }\n}\n"
169+
"value": "{\n \"name\": \"{{ unique }}\",\n \"type\": \"log alert\",\n \"query\": \"logs(\\\"service:foo AND type:error\\\").index(\\\"main\\\").rollup(\\\"count\\\").by(\\\"source\\\").last(\\\"5m\\\") > 2\",\n \"message\": \"some message Notify: @hipchat-channel\",\n \"tags\": [\"test:{{ unique_lower_alnum }}\", \"env:ci\"],\n \"priority\": 3,\n \"options\": {\n \"enable_logs_sample\": true,\n \"escalation_message\": \"the situation has escalated\",\n \"evaluation_delay\": 700,\n \"include_tags\": true,\n \"locked\": false,\n \"new_host_delay\": 600,\n \"no_data_timeframe\": null,\n \"notify_audit\": false,\n \"notify_no_data\": false,\n \"on_missing_data\": \"show_and_notify_no_data\",\n \"notification_preset_name\": \"hide_handles\",\n \"renotify_interval\": 60,\n \"require_full_window\": true,\n \"timeout_h\": 24,\n \"thresholds\": { \"critical\": 2, \"warning\": 1 }\n }\n}\n"
170170
}
171171
],
172172
"step": "there is a valid \"monitor\" in the system",

0 commit comments

Comments
 (0)