Skip to content

Commit

Permalink
Regenerate client from commit 1fe3e9c6 of spec repo
Browse files Browse the repository at this point in the history
  • Loading branch information
ci.datadog-api-spec committed Nov 1, 2024
1 parent 0a227b7 commit 8dd66f8
Show file tree
Hide file tree
Showing 31 changed files with 6,899 additions and 5,436 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-31 16:41:34.646210",
"spec_repo_commit": "63c441b2"
"regenerated": "2024-11-01 15:02:38.997271",
"spec_repo_commit": "1fe3e9c6"
},
"v2": {
"apigentools_version": "1.6.6",
"regenerated": "2024-10-31 16:41:34.664132",
"spec_repo_commit": "63c441b2"
"regenerated": "2024-11-01 15:02:39.014820",
"spec_repo_commit": "1fe3e9c6"
}
}
}
273 changes: 273 additions & 0 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3997,6 +3997,241 @@ components:
format: int64
type: integer
type: object
ChangeEvent:
description: Event attributes.
properties:
aggregation_key:
description: An arbitrary string to use for aggregation when correlating
events. Limited to 100 characters.
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 when 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 the timestamp of receipt. 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
example: event
type: string
type: object
ChangeEventCreateResponseAttributes:
description: Event response attributes.
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 information related to the `change` event.
Can be arbitrarily nested and contain any valid JSON.
example:
dd:
team: datadog_team
user_email: [email protected]
user_id: datadog_user_id
user_name: datadog_username
resource_link: datadog.com/feature/fallback_payments_test
type: object
changed_resource:
$ref: '#/components/schemas/ChangeEventCustomAttributesChangedResource'
impacted_resources:
description: 'A list of resources impacted by this change. It is recommended
to provide an impacted resource to display

the change event at the right location. Only resources of type `service`
are supported.'
example:
- name: payments_api
type: service
items:
$ref: '#/components/schemas/ChangeEventCustomAttributesImpactedResourcesItems'
type: array
new_value:
additionalProperties: {}
description: Free form object to track new value of the changed resource.
example:
enabled: true
percentage: 50%
rule:
datacenter: devcycle.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: devcycle.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: [email protected]
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 @@ -30287,6 +30522,44 @@ paths:
operator: OR
permissions:
- events_read
post:
description: This endpoint allows you to post events. Only events with `change`
category are under General Availability.
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
/api/v2/events/search:
post:
description: 'List endpoint returns events that match an events search query.
Expand Down
31 changes: 12 additions & 19 deletions docs/datadog_api_client.rst
Original file line number Diff line number Diff line change
@@ -1,55 +1,48 @@
datadog\_api\_client package
============================

Subpackages
-----------
datadog\_api\_client
====================

.. toctree::
:maxdepth: 4

datadog_api_client.v1
datadog_api_client.v2

Submodules
----------

datadog\_api\_client.api\_client module
---------------------------------------
api\_client
-----------

.. automodule:: datadog_api_client.api_client
:members:
:show-inheritance:

datadog\_api\_client.configuration module
-----------------------------------------
configuration
-------------

.. automodule:: datadog_api_client.configuration
:members:
:show-inheritance:

datadog\_api\_client.exceptions module
--------------------------------------
exceptions
----------

.. automodule:: datadog_api_client.exceptions
:members:
:show-inheritance:

datadog\_api\_client.model\_utils module
----------------------------------------
model\_utils
------------

.. automodule:: datadog_api_client.model_utils
:members:
:show-inheritance:

datadog\_api\_client.rest module
--------------------------------
rest
----

.. automodule:: datadog_api_client.rest
:members:
:show-inheritance:

Module contents
---------------

.. automodule:: datadog_api_client
:members:
Expand Down
Loading

0 comments on commit 8dd66f8

Please sign in to comment.