Regenerate client from commit 9f916c56 of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-08 14:34:51.506122",
-            "spec_repo_commit": "4b632dba"
+            "regenerated": "2025-05-09 01:01:31.989820",
+            "spec_repo_commit": "9f916c56"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-05-08 14:34:51.522046",
-            "spec_repo_commit": "4b632dba"
+            "regenerated": "2025-05-09 01:01:32.006834",
+            "spec_repo_commit": "9f916c56"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -2138,6 +2138,89 @@ components:
       - id
       - base_severity
       type: object
+    AlertEventCustomAttributes:
+      additionalProperties: false
+      description: Object representing custom alert event attributes.
+      properties:
+        custom:
+          $ref: '#/components/schemas/AlertEventCustomAttributesCustom'
+        links:
+          $ref: '#/components/schemas/AlertEventCustomAttributesLinks'
+        priority:
+          $ref: '#/components/schemas/AlertEventCustomAttributesPriority'
+        status:
+          $ref: '#/components/schemas/AlertEventCustomAttributesStatus'
+      type: object
+    AlertEventCustomAttributesCustom:
+      additionalProperties: {}
+      description: Custom attributes. Support up to 100 properties and a maximum nesting
+        depth of 10 levels.
+      example: {}
+      type: object
+    AlertEventCustomAttributesLinks:
+      description: The links related to the event.
+      items:
+        $ref: '#/components/schemas/AlertEventCustomAttributesLinksItems'
+      maxItems: 20
+      minItems: 1
+      type: array
+    AlertEventCustomAttributesLinksItems:
+      description: A link.
+      properties:
+        category:
+          $ref: '#/components/schemas/AlertEventCustomAttributesLinksItemsCategory'
+        title:
+          description: The title of the link. Limited to 300 characters.
+          example: Runbook Link
+          maxLength: 300
+          type: string
+        url:
+          description: The URL of the link. Limited to 2048 characters.
+          example: https://app.datadoghq.com/runbook
+          maxLength: 2048
+          type: string
+      required:
+      - url
+      - category
+      type: object
+    AlertEventCustomAttributesLinksItemsCategory:
+      description: The category of the link.
+      enum:
+      - runbook
+      example: runbook
+      type: string
+      x-enum-varnames:
+      - RUNBOOK
+    AlertEventCustomAttributesPriority:
+      description: The priority of the alert.
+      enum:
+      - '1'
+      - '2'
+      - '3'
+      - '4'
+      - '5'
+      example: '1'
+      type: string
+      x-enum-varnames:
+      - PRIORITY_ONE
+      - PRIORITY_TWO
+      - PRIORITY_THREE
+      - PRIORITY_FOUR
+      - PRIORITY_FIVE
+    AlertEventCustomAttributesStatus:
+      description: The status of the alert.
+      enum:
+      - info
+      - warn
+      - error
+      - ok
+      example: warn
+      type: string
+      x-enum-varnames:
+      - INFO
+      - WARN
+      - ERROR
+      - OK
     Annotation:
       description: A list of annotations used in the workflow. These are like sticky
         notes for your workflow!
@@ -13904,28 +13987,34 @@ components:
           type: string
       type: object
     EventCategory:
-      description: Event category to identify the type of event. Only the value `change`
-        is supported. Support for other categories are coming. please reach out to
-        datadog support if you're interested.
+      description: Event category to identify the type of event. For example, `change`
+        or `alert`.
       enum:
       - change
+      - alert
       example: change
       type: string
       x-enum-varnames:
       - CHANGE
+      - ALERT
     EventCreateRequest:
       description: Object representing an event creation request.
       properties:
         attributes:
           $ref: '#/components/schemas/EventPayload'
         type:
           $ref: '#/components/schemas/EventCreateRequestType'
+      required:
+      - type
+      - attributes
       type: object
     EventCreateRequestPayload:
       description: Payload for creating an event.
       properties:
         data:
           $ref: '#/components/schemas/EventCreateRequest'
+      required:
+      - data
       type: object
     EventCreateRequestType:
       description: Entity type.
@@ -13940,6 +14029,12 @@ components:
       properties:
         attributes:
           $ref: '#/components/schemas/EventCreateResponseAttributes'
+        id:
+          description: A numerical ID compatible with the V1 endpoint. This field
+            is not populated in response from the V2 endpoint. To retrieve this ID,
+            refer to the event attributes in the Event Explorer.
+          example: _
+          type: string
         type:
           description: Event type
           example: event
@@ -13961,28 +14056,44 @@ components:
     EventCreateResponseAttributesAttributesEvt:
       description: JSON object of event system attributes.
       properties:
-        id:
-          description: Event id
+        uid:
+          description: A unique identifier for the event. You can use this ID to query
+            or reference the event in the V2 endpoint.
+          example: ABCDEFGHIJKLMNOPQRSTUVWX
           type: string
       type: object
     EventCreateResponsePayload:
       description: Response containing information about created event.
       properties:
         data:
           $ref: '#/components/schemas/EventCreateResponse'
+        links:
+          $ref: '#/components/schemas/EventCreateResponsePayloadLinks'
+      type: object
+    EventCreateResponsePayloadLinks:
+      description: Links attributes.
+      properties:
+        self:
+          description: The URL of the event. This link is only functional when using
+            the `app` subdomain.
+          example: https://app.datadoghq.com/event/event?uid=ABCDEFGHIJKLMNOPQRSTUVWX
+          type: string
       type: object
     EventPayload:
       description: Event attributes.
       properties:
         aggregation_key:
           description: An arbitrary string to use for aggregation when correlating
             events. Limited to 100 characters.
+          example: aggregation_key_123
           maxLength: 100
           type: string
         attributes:
           $ref: '#/components/schemas/EventPayloadAttributes'
         category:
           $ref: '#/components/schemas/EventCategory'
+        integration_id:
+          $ref: '#/components/schemas/EventPayloadIntegrationId'
         message:
           description: The body of the event. Limited to 4000 characters.
           example: payment_processed feature flag has been enabled
@@ -13996,7 +14107,10 @@ components:
           - env:test
           items:
             description: A tag.
+            maxLength: 200
             type: string
+          maxItems: 100
+          minItems: 1
           type: array
         timestamp:
           description: 'Timestamp when the event occurred. Must follow [ISO 8601](https://www.iso.org/iso-8601-date-and-time-format.html)
@@ -14022,6 +14136,16 @@ components:
         event category.
       oneOf:
       - $ref: '#/components/schemas/ChangeEventCustomAttributes'
+      - $ref: '#/components/schemas/AlertEventCustomAttributes'
+    EventPayloadIntegrationId:
+      description: Integration IDs sourced from integration manifests. Currently,
+        only `custom-events` is supported.
+      enum:
+      - custom-events
+      example: custom-events
+      type: string
+      x-enum-varnames:
+      - CUSTOM_EVENTS
     EventPriority:
       description: The priority of the event's monitor. For example, `normal` or `low`.
       enum:
@@ -45640,7 +45764,8 @@ paths:
         - events_read
     post:
       description: "This endpoint allows you to post events.\n\n\u2705 **Only events
-        with the `change` category** are in General Availability. See [Change Tracking](https://docs.datadoghq.com/change_tracking)
+        with the `change` or `alert` category** are in General Availability. For change
+        events, see [Change Tracking](https://docs.datadoghq.com/change_tracking)
         for more details.\n\n\u274C For use cases involving other event categories,
         please use the V1 endpoint."
       operationId: CreateEvent
@@ -45652,6 +45777,7 @@ paths:
                 value:
                   data:
                     attributes:
+                      aggregation_key: aggregation_key_123
                       attributes:
                         author:
                           name: [email protected]
@@ -45680,6 +45806,7 @@ paths:
                           rule:
                             datacenter: devcycle.us1.prod
                       category: change
+                      integration_id: custom-events
                       message: payment_processed feature flag has been enabled
                       tags:
                       - env:test
@@ -45690,7 +45817,7 @@ paths:
         description: Event request object
         required: true
       responses:
-        '200':
+        '202':
           content:
             application/json:
               schema:
@@ -45713,6 +45840,38 @@ paths:
       security:
       - apiKeyAuth: []
         appKeyAuth: []
+      servers:
+      - url: https://{subdomain}.{site}
+        variables:
+          site:
+            default: datadoghq.com
+            description: The regional site for customers.
+            enum:
+            - datadoghq.com
+            - us3.datadoghq.com
+            - us5.datadoghq.com
+            - ap1.datadoghq.com
+            - datadoghq.eu
+            - ddog-gov.com
+          subdomain:
+            default: event-management-intake
+            description: The subdomain where the API is deployed.
+      - url: '{protocol}://{name}'
+        variables:
+          name:
+            default: event-management-intake.datadoghq.com
+            description: Full site DNS name.
+          protocol:
+            default: https
+            description: The protocol for accessing the API.
+      - url: https://{subdomain}.{site}
+        variables:
+          site:
+            default: datadoghq.com
+            description: Any Datadog deployment.
+          subdomain:
+            default: event-management-intake
+            description: The subdomain where the API is deployed.
       summary: Post an event
       tags:
       - Events

examples/v2/events/CreateEvent.rb

@@ -6,6 +6,7 @@
 body = DatadogAPIClient::V2::EventCreateRequestPayload.new({
   data: DatadogAPIClient::V2::EventCreateRequest.new({
     attributes: DatadogAPIClient::V2::EventPayload.new({
+      aggregation_key: "aggregation_key_123",
       attributes: DatadogAPIClient::V2::ChangeEventCustomAttributes.new({
         author: DatadogAPIClient::V2::ChangeEventCustomAttributesAuthor.new({
           name: "[email protected]",
@@ -32,6 +33,7 @@
         },
       }),
       category: DatadogAPIClient::V2::EventCategory::CHANGE,
+      integration_id: DatadogAPIClient::V2::EventPayloadIntegrationId::CUSTOM_EVENTS,
       message: "payment_processed feature flag has been enabled",
       tags: [
         "env:test",

features/v2/events.feature

@@ -53,16 +53,16 @@ Feature: Events
   @generated @skip @team:DataDog/event-management
   Scenario: Post an event returns "Bad request" response
     Given new "CreateEvent" request
-    And body with value {"data": {"attributes": {"attributes": {"author": {"name": "[email protected]", "type": "user"}, "change_metadata": {"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"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "message": "payment_processed feature flag has been enabled", "tags": ["env:test"], "title": "payment_processed feature flag updated"}, "type": "event"}}
+    And body with value {"data": {"attributes": {"aggregation_key": "aggregation_key_123", "attributes": {"author": {"name": "[email protected]", "type": "user"}, "change_metadata": {"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"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "integration_id": "custom-events", "message": "payment_processed feature flag has been enabled", "tags": ["env:test"], "title": "payment_processed feature flag updated"}, "type": "event"}}
     When the request is sent
     Then the response status is 400 Bad request
 
   @generated @skip @team:DataDog/event-management
   Scenario: Post an event returns "OK" response
     Given new "CreateEvent" request
-    And body with value {"data": {"attributes": {"attributes": {"author": {"name": "[email protected]", "type": "user"}, "change_metadata": {"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"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "message": "payment_processed feature flag has been enabled", "tags": ["env:test"], "title": "payment_processed feature flag updated"}, "type": "event"}}
+    And body with value {"data": {"attributes": {"aggregation_key": "aggregation_key_123", "attributes": {"author": {"name": "[email protected]", "type": "user"}, "change_metadata": {"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"}, "changed_resource": {"name": "fallback_payments_test", "type": "feature_flag"}, "impacted_resources": [{"name": "payments_api", "type": "service"}], "new_value": {"enabled": true, "percentage": "50%", "rule": {"datacenter": "devcycle.us1.prod"}}, "prev_value": {"enabled": true, "percentage": "10%", "rule": {"datacenter": "devcycle.us1.prod"}}}, "category": "change", "integration_id": "custom-events", "message": "payment_processed feature flag has been enabled", "tags": ["env:test"], "title": "payment_processed feature flag updated"}, "type": "event"}}
     When the request is sent
-    Then the response status is 200 OK
+    Then the response status is 202 OK
 
   @team:DataDog/event-management
   Scenario: Search events returns "Bad Request" response