Skip to content

Commit 7434a17

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit 3cbe2c1b of spec repo
1 parent 0684b39 commit 7434a17

26 files changed

+1522
-12
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-17 14:10:51.942099",
8-
"spec_repo_commit": "fb024a45"
7+
"regenerated": "2024-10-17 16:52:22.056630",
8+
"spec_repo_commit": "3cbe2c1b"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.6",
12-
"regenerated": "2024-10-17 14:10:51.959206",
13-
"spec_repo_commit": "fb024a45"
12+
"regenerated": "2024-10-17 16:52:22.074276",
13+
"spec_repo_commit": "3cbe2c1b"
1414
}
1515
}
1616
}

.generator/schemas/v2/openapi.yaml

Lines changed: 278 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3951,6 +3951,243 @@ components:
39513951
format: int64
39523952
type: integer
39533953
type: object
3954+
ChangeEvent:
3955+
description: Event attributes.
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+
ChangeEventCreateRequestPayload:
4020+
description: Create an event.
4021+
properties:
4022+
data:
4023+
$ref: '#/components/schemas/ChangeEventCreateRequest'
4024+
type: object
4025+
ChangeEventCreateRequestType:
4026+
description: Entity type.
4027+
enum:
4028+
- event
4029+
example: event
4030+
type: string
4031+
x-enum-varnames:
4032+
- EVENT
4033+
ChangeEventCreateResponse:
4034+
description: Object containing an event response.
4035+
properties:
4036+
attributes:
4037+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributes'
4038+
type:
4039+
description: Event type
4040+
example: event
4041+
type: string
4042+
type: object
4043+
ChangeEventCreateResponseAttributes:
4044+
description: Event response attributes.
4045+
properties:
4046+
attributes:
4047+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributes'
4048+
type: object
4049+
ChangeEventCreateResponseAttributesAttributes:
4050+
description: The definition of `ChangeEventCreateResponseAttributesAttributes`
4051+
object.
4052+
properties:
4053+
evt:
4054+
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributesEvt'
4055+
type: object
4056+
ChangeEventCreateResponseAttributesAttributesEvt:
4057+
description: The definition of `ChangeEventCreateResponseAttributesAttributesEvt`
4058+
object.
4059+
properties:
4060+
id:
4061+
description: Event id
4062+
type: string
4063+
type: object
4064+
ChangeEventCreateResponsePayload:
4065+
description: Response containing information about created event.
4066+
properties:
4067+
data:
4068+
$ref: '#/components/schemas/ChangeEventCreateResponse'
4069+
type: object
4070+
ChangeEventCustomAttributes:
4071+
description: Object representing custom event attributes.
4072+
properties:
4073+
author:
4074+
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
4075+
change_metadata:
4076+
additionalProperties: {}
4077+
description: Free form object with any related information of the `change`
4078+
event.
4079+
example:
4080+
dd:
4081+
team: datadog_team
4082+
user_email: [email protected]
4083+
user_id: datadog_user_id
4084+
user_name: datadog_username
4085+
resource_link: datadog.com/feature/fallback_payments_test
4086+
type: object
4087+
changed_resource:
4088+
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource'
4089+
impacted_resources:
4090+
description: 'A list of resources impacted by this change. It is recommended
4091+
to provide an impacted resource to display
4092+
4093+
the change event at the right location. Only resources of type `service`
4094+
are supported.'
4095+
example:
4096+
- name: payments_api
4097+
type: service
4098+
items:
4099+
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
4100+
type: array
4101+
new_value:
4102+
additionalProperties: {}
4103+
description: Free form object to track new value of the changed resource.
4104+
example:
4105+
enabled: true
4106+
percentage: 50%
4107+
rule:
4108+
datacenter: devcycle.us1.prod
4109+
type: object
4110+
prev_value:
4111+
additionalProperties: {}
4112+
description: Free form object to track previous value of the changed resource.
4113+
example:
4114+
enabled: true
4115+
percentage: 10%
4116+
rule:
4117+
datacenter: devcycle.us1.prod
4118+
type: object
4119+
required:
4120+
- changed_resource
4121+
type: object
4122+
ChangeEventCustomAttributesAuthor:
4123+
description: Object representing the entity which made the change. Optional
4124+
field but if provided should include `type` and `name`.
4125+
properties:
4126+
name:
4127+
description: Author's name. Limited to 128 characters.
4128+
4129+
maxLength: 128
4130+
type: string
4131+
type:
4132+
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
4133+
required:
4134+
- name
4135+
- type
4136+
type: object
4137+
ChangeEventCustomAttributesAuthorType:
4138+
description: Author's type.
4139+
enum:
4140+
- user
4141+
- system
4142+
example: user
4143+
type: string
4144+
x-enum-varnames:
4145+
- USER
4146+
- SYSTEM
4147+
ChangeEventCustomAttributesChangedResource:
4148+
description: Object representing a uniquely identified resource. Only the resource
4149+
type `feature_flag` is supported.
4150+
properties:
4151+
name:
4152+
description: Resource's name.
4153+
example: fallback_payments_test
4154+
type: string
4155+
type:
4156+
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
4157+
required:
4158+
- type
4159+
- name
4160+
type: object
4161+
ChangeEventCustomAttributesChangedResourceType:
4162+
description: Resource's type.
4163+
enum:
4164+
- feature_flag
4165+
example: feature_flag
4166+
type: string
4167+
x-enum-varnames:
4168+
- FEATURE_FLAG
4169+
ChangeEventCustomAttributesImpactedResourcesItems:
4170+
description: Object representing a uniquely identified resource. Only the resource
4171+
type `service` is supported.
4172+
properties:
4173+
name:
4174+
description: Resource's name.
4175+
example: payments_api
4176+
type: string
4177+
type:
4178+
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
4179+
required:
4180+
- type
4181+
- name
4182+
type: object
4183+
ChangeEventCustomAttributesImpactedResourcesItemsType:
4184+
description: Resource's type.
4185+
enum:
4186+
- service
4187+
example: service
4188+
type: string
4189+
x-enum-varnames:
4190+
- SERVICE
39544191
ChargebackBreakdown:
39554192
description: Charges breakdown.
39564193
properties:
@@ -29664,6 +29901,47 @@ paths:
2966429901
operator: OR
2966529902
permissions:
2966629903
- events_read
29904+
post:
29905+
description: This endpoint allows you to post events. Only events with `change`
29906+
category are supported.
29907+
operationId: CreateEvent
29908+
requestBody:
29909+
content:
29910+
application/json:
29911+
schema:
29912+
$ref: '#/components/schemas/ChangeEventCreateRequestPayload'
29913+
description: Event request object
29914+
required: true
29915+
responses:
29916+
'200':
29917+
content:
29918+
application/json:
29919+
schema:
29920+
$ref: '#/components/schemas/ChangeEventCreateResponsePayload'
29921+
description: OK
29922+
'400':
29923+
content:
29924+
application/json:
29925+
schema:
29926+
$ref: '#/components/schemas/JSONAPIErrorResponse'
29927+
description: Bad request
29928+
'403':
29929+
content:
29930+
application/json:
29931+
schema:
29932+
$ref: '#/components/schemas/JSONAPIErrorResponse'
29933+
description: Forbidden
29934+
'429':
29935+
$ref: '#/components/responses/TooManyRequestsResponse'
29936+
security:
29937+
- apiKeyAuth: []
29938+
summary: Post a change event
29939+
tags:
29940+
- Events
29941+
x-codegen-request-body-name: body
29942+
x-unstable: '**Note**: This endpoint is in **Preview**.
29943+
29944+
If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
2966729945
/api/v2/events/search:
2966829946
post:
2966929947
description: 'List endpoint returns events that match an events search query.

0 commit comments

Comments
 (0)