Skip to content

Commit

Permalink
Regenerate client from commit e7e2a6e5 of spec repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ci.datadog-api-spec committed Oct 15, 2024
1 parent 17306bb commit ac660ff
Show file tree
Hide file tree
Showing 26 changed files with 2,202 additions and 12 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
"spec_versions": {
"v1": {
"apigentools_version": "1.6.6",
"regenerated": "2024-10-10 19:46:04.854996",
"spec_repo_commit": "049920eb"
"regenerated": "2024-10-15 08:56:15.902250",
"spec_repo_commit": "e7e2a6e5"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-10-10 19:46:04.873453",
"spec_repo_commit": "049920eb"
"regenerated": "2024-10-15 08:56:15.920605",
"spec_repo_commit": "e7e2a6e5"
}
}
}
275 changes: 275 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3951,6 +3951,240 @@ components:
format: int64
type: integer
type: object
ChangeEvent:
description: Object representing a change event.
properties:
aggregation_key:
description: 'An arbitrary string to use for aggregation. Limited to 100
characters.

If you specify a key, all events using that key are grouped together in
the Event Stream.'
maxLength: 100
type: string
attributes:
$ref: '#/components/schemas/ChangeEventCustomAttributes'
category:
$ref: '#/components/schemas/ChangeEventCategory'
message:
description: The body of the event. Limited to 4000 characters.
example: payment_processed feature flag has been enabled
maxLength: 4000
type: string
tags:
description: 'A list of tags to apply to the event.

Refer to [Tags docs](https://docs.datadoghq.com/getting_started/tagging/).'
example:
- environment:test
items:
description: A tag.
type: string
type: array
timestamp:
description: 'Timestamp in which the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
format.

For example `"2017-01-15T01:30:15.010000Z"`.

Defaults to now. Limited to values no older than 18 hours.'
type: string
title:
description: The event title. Limited to 500 characters.
example: payment_processed feature flag updated
maxLength: 500
type: string
required:
- title
- category
- attributes
type: object
ChangeEventCategory:
description: Event category to identify the type of event. Only the value `change`
is supported.
enum:
- change
example: change
type: string
x-enum-varnames:
- CHANGE
ChangeEventCreateRequest:
description: Object representing an event.
properties:
attributes:
$ref: '#/components/schemas/ChangeEvent'
type:
$ref: '#/components/schemas/ChangeEventCreateRequestType'
type: object
ChangeEventCreateRequestPayload:
description: Create an event.
properties:
data:
$ref: '#/components/schemas/ChangeEventCreateRequest'
type: object
ChangeEventCreateRequestType:
description: Entity type.
enum:
- event
example: event
type: string
x-enum-varnames:
- EVENT
ChangeEventCreateResponse:
description: Object containing an event response.
properties:
attributes:
$ref: '#/components/schemas/ChangeEventCreateResponseAttributes'
type:
description: Event type
type: string
type: object
ChangeEventCreateResponseAttributes:
description: The definition of `ChangeEventCreateResponseAttributes` object.
properties:
attributes:
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributes'
type: object
ChangeEventCreateResponseAttributesAttributes:
description: The definition of `ChangeEventCreateResponseAttributesAttributes`
object.
properties:
evt:
$ref: '#/components/schemas/ChangeEventCreateResponseAttributesAttributesEvt'
type: object
ChangeEventCreateResponseAttributesAttributesEvt:
description: The definition of `ChangeEventCreateResponseAttributesAttributesEvt`
object.
properties:
id:
description: Event id
type: string
type: object
ChangeEventCreateResponsePayload:
description: Response containing information about created event.
properties:
data:
$ref: '#/components/schemas/ChangeEventCreateResponse'
type: object
ChangeEventCustomAttributes:
description: Object representing custom event attributes.
properties:
author:
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthor'
change_metadata:
additionalProperties: {}
description: Free form object with any related information of the `change`
event.
example:
resource_link: /feature/fallback_payments_test
user:
email: user@example.com
name: dd_user
type: object
changed_resource:
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource'
impacted_resources:
description: 'A list of resources impacted by this change. At least one
resource is required. Only resources

of type `service` are supported.'
example:
- name: payments_api
type: service
items:
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
minItems: 1
type: array
new_value:
additionalProperties: {}
description: Free form object to track new value of the changed resource.
example:
enabled: true
percentage: 50%
rule:
datacenter: us1.prod
type: object
prev_value:
additionalProperties: {}
description: Free form object to track previous value of the changed resource.
example:
enabled: true
percentage: 10%
rule:
datacenter: us1.prod
type: object
required:
- changed_resource
type: object
ChangeEventCustomAttributesAuthor:
description: Object representing the entity which made the change. Optional
field but if provided should include `type` and `name`.
properties:
name:
description: Author's name. Limited to 128 characters.
example: user_name
maxLength: 128
type: string
type:
$ref: '#/components/schemas/ChangeEventCustomAttributesAuthorType'
required:
- name
- type
type: object
ChangeEventCustomAttributesAuthorType:
description: Author's type.
enum:
- user
- system
example: user
type: string
x-enum-varnames:
- USER
- SYSTEM
ChangeEventCustomAttributesChangedResource:
description: Object representing a uniquely identified resource. Only the resource
type `feature_flag` is supported.
properties:
name:
description: Resource's name.
example: fallback_payments_test
type: string
type:
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResourceType'
required:
- type
- name
type: object
ChangeEventCustomAttributesChangedResourceType:
description: Resource's type.
enum:
- feature_flag
example: feature_flag
type: string
x-enum-varnames:
- FEATURE_FLAG
ChangeEventCustomAttributesImpactedResourcesItems:
description: Object representing a uniquely identified resource. Only the resource
type `service` is supported.
properties:
name:
description: Resource's name.
example: payments_api
type: string
type:
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItemsType'
required:
- type
- name
type: object
ChangeEventCustomAttributesImpactedResourcesItemsType:
description: Resource's type.
enum:
- service
example: service
type: string
x-enum-varnames:
- SERVICE
ChargebackBreakdown:
description: Charges breakdown.
properties:
Expand Down Expand Up @@ -29664,6 +29898,47 @@ paths:
operator: OR
permissions:
- events_read
post:
description: This endpoint allows you to post events. Only events with `change`
category are supported.
operationId: CreateEvent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEventCreateRequestPayload'
description: Event request object
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/ChangeEventCreateResponsePayload'
description: OK
'400':
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: Bad request
'403':
content:
application/json:
schema:
$ref: '#/components/schemas/JSONAPIErrorResponse'
description: Forbidden
'429':
$ref: '#/components/responses/TooManyRequestsResponse'
security:
- apiKeyAuth: []
summary: Post a change event
tags:
- Events
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is in **Preview**.

If you have any feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
/api/v2/events/search:
post:
description: 'List endpoint returns events that match an events search query.
Expand Down
47 changes: 47 additions & 0 deletions examples/v2/events/CreateEvent.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
# Post a change event returns "OK" response

require "datadog_api_client"
DatadogAPIClient.configure do |config|
config.unstable_operations["v2.create_event".to_sym] = true
end
api_instance = DatadogAPIClient::V2::EventsAPI.new

body = DatadogAPIClient::V2::ChangeEventCreateRequestPayload.new({
data: DatadogAPIClient::V2::ChangeEventCreateRequest.new({
attributes: DatadogAPIClient::V2::ChangeEvent.new({
attributes: DatadogAPIClient::V2::ChangeEventCustomAttributes.new({
author: DatadogAPIClient::V2::ChangeEventCustomAttributesAuthor.new({
name: "user_name",
type: DatadogAPIClient::V2::ChangeEventCustomAttributesAuthorType::USER,
}),
change_metadata: {
"resource_link": "/feature/fallback_payments_test", "user": "{'email': 'user@example.com', 'name': 'dd_user'}",
},
changed_resource: DatadogAPIClient::V2::ChangeEventCustomAttributesChangedResource.new({
name: "fallback_payments_test",
type: DatadogAPIClient::V2::ChangeEventCustomAttributesChangedResourceType::FEATURE_FLAG,
}),
impacted_resources: [
DatadogAPIClient::V2::ChangeEventCustomAttributesImpactedResourcesItems.new({
name: "payments_api",
type: DatadogAPIClient::V2::ChangeEventCustomAttributesImpactedResourcesItemsType::SERVICE,
}),
],
new_value: {
"enabled": "True", "percentage": "50%", "rule": "{'datacenter': 'us1.prod'}",
},
prev_value: {
"enabled": "True", "percentage": "10%", "rule": "{'datacenter': 'us1.prod'}",
},
}),
category: DatadogAPIClient::V2::ChangeEventCategory::CHANGE,
message: "payment_processed feature flag has been enabled",
tags: [
"environment:test",
],
title: "payment_processed feature flag updated",
}),
type: DatadogAPIClient::V2::ChangeEventCreateRequestType::EVENT,
}),
})
p api_instance.create_event(body)
3 changes: 3 additions & 0 deletions features/scenarios_model_mapping.rb
Original file line number Diff line number Diff line change
Expand Up @@ -1224,6 +1224,9 @@
"page_cursor" => "String",
"page_limit" => "Integer",
},
"v2.CreateEvent" => {
"body" => "ChangeEventCreateRequestPayload",
},
"v2.SearchEvents" => {
"body" => "EventsListRequest",
},
Expand Down
Loading

0 comments on commit ac660ff

Please sign in to comment.