Update Incident API specs to include is_test in POST /incidents and incidents response (#744)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 53b8035b0f70 · 2025-06-25T22:19:36.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-25 17:36:53.162860",
-            "spec_repo_commit": "51c17453"
+            "regenerated": "2025-06-25 21:28:44.094918",
+            "spec_repo_commit": "31044eb9"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-06-25 17:36:53.178661",
-            "spec_repo_commit": "51c17453"
+            "regenerated": "2025-06-25 21:28:44.111040",
+            "spec_repo_commit": "31044eb9"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -17419,6 +17419,10 @@ components:
           items:
             $ref: '#/components/schemas/IncidentTimelineCellCreateAttributes'
           type: array
+        is_test:
+          description: A flag indicating whether the incident is a test incident.
+          example: false
+          type: boolean
         notification_handles:
           description: Notification handles that will be notified of the incident
             at creation.
@@ -17824,6 +17828,10 @@ components:
           description: A unique identifier that represents an incident type.
           example: 00000000-0000-0000-0000-000000000000
           type: string
+        is_test:
+          description: A flag indicating whether the incident is a test incident.
+          example: false
+          type: boolean
         modified:
           description: Timestamp when the incident was last modified.
           format: date-time
diff --git a/src/datadogV2/model/model_incident_create_attributes.rs b/src/datadogV2/model/model_incident_create_attributes.rs
@@ -28,6 +28,9 @@ pub struct IncidentCreateAttributes {
     /// An array of initial timeline cells to be placed at the beginning of the incident timeline.
     #[serde(rename = "initial_cells")]
     pub initial_cells: Option<Vec<crate::datadogV2::model::IncidentTimelineCellCreateAttributes>>,
+    /// A flag indicating whether the incident is a test incident.
+    #[serde(rename = "is_test")]
+    pub is_test: Option<bool>,
     /// Notification handles that will be notified of the incident at creation.
     #[serde(rename = "notification_handles")]
     pub notification_handles: Option<Vec<crate::datadogV2::model::IncidentNotificationHandle>>,
@@ -49,6 +52,7 @@ impl IncidentCreateAttributes {
             fields: None,
             incident_type_uuid: None,
             initial_cells: None,
+            is_test: None,
             notification_handles: None,
             title,
             additional_properties: std::collections::BTreeMap::new(),
@@ -82,6 +86,11 @@ impl IncidentCreateAttributes {
         self
     }
 
+    pub fn is_test(mut self, value: bool) -> Self {
+        self.is_test = Some(value);
+        self
+    }
+
     pub fn notification_handles(
         mut self,
         value: Vec<crate::datadogV2::model::IncidentNotificationHandle>,
@@ -128,6 +137,7 @@ impl<'de> Deserialize<'de> for IncidentCreateAttributes {
                 let mut initial_cells: Option<
                     Vec<crate::datadogV2::model::IncidentTimelineCellCreateAttributes>,
                 > = None;
+                let mut is_test: Option<bool> = None;
                 let mut notification_handles: Option<
                     Vec<crate::datadogV2::model::IncidentNotificationHandle>,
                 > = None;
@@ -171,6 +181,12 @@ impl<'de> Deserialize<'de> for IncidentCreateAttributes {
                             initial_cells =
                                 Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "is_test" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            is_test = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "notification_handles" => {
                             if v.is_null() {
                                 continue;
@@ -198,6 +214,7 @@ impl<'de> Deserialize<'de> for IncidentCreateAttributes {
                     fields,
                     incident_type_uuid,
                     initial_cells,
+                    is_test,
                     notification_handles,
                     title,
                     additional_properties,
diff --git a/src/datadogV2/model/model_incident_response_attributes.rs b/src/datadogV2/model/model_incident_response_attributes.rs
@@ -71,6 +71,9 @@ pub struct IncidentResponseAttributes {
     /// A unique identifier that represents an incident type.
     #[serde(rename = "incident_type_uuid")]
     pub incident_type_uuid: Option<String>,
+    /// A flag indicating whether the incident is a test incident.
+    #[serde(rename = "is_test")]
+    pub is_test: Option<bool>,
     /// Timestamp when the incident was last modified.
     #[serde(rename = "modified")]
     pub modified: Option<chrono::DateTime<chrono::Utc>>,
@@ -149,6 +152,7 @@ impl IncidentResponseAttributes {
             detected: None,
             fields: None,
             incident_type_uuid: None,
+            is_test: None,
             modified: None,
             non_datadog_creator: None,
             notification_handles: None,
@@ -225,6 +229,11 @@ impl IncidentResponseAttributes {
         self
     }
 
+    pub fn is_test(mut self, value: bool) -> Self {
+        self.is_test = Some(value);
+        self
+    }
+
     pub fn modified(mut self, value: chrono::DateTime<chrono::Utc>) -> Self {
         self.modified = Some(value);
         self
@@ -333,6 +342,7 @@ impl<'de> Deserialize<'de> for IncidentResponseAttributes {
                     >,
                 > = None;
                 let mut incident_type_uuid: Option<String> = None;
+                let mut is_test: Option<bool> = None;
                 let mut modified: Option<chrono::DateTime<chrono::Utc>> = None;
                 let mut non_datadog_creator: Option<
                     Option<crate::datadogV2::model::IncidentNonDatadogCreator>,
@@ -412,6 +422,12 @@ impl<'de> Deserialize<'de> for IncidentResponseAttributes {
                             incident_type_uuid =
                                 Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "is_test" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            is_test = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "modified" => {
                             if v.is_null() {
                                 continue;
@@ -509,6 +525,7 @@ impl<'de> Deserialize<'de> for IncidentResponseAttributes {
                     detected,
                     fields,
                     incident_type_uuid,
+                    is_test,
                     modified,
                     non_datadog_creator,
                     notification_handles,
diff --git a/tests/scenarios/features/v2/incidents.feature b/tests/scenarios/features/v2/incidents.feature
@@ -70,7 +70,7 @@ Feature: Incidents
   Scenario: Create an incident returns "Bad Request" response
     Given operation "CreateIncident" enabled
     And new "CreateIncident" request
-    And body with value {"data": {"attributes": {"customer_impact_scope": "Example customer impact scope", "customer_impacted": false, "fields": {"severity": {"type": "dropdown", "value": "SEV-5"}}, "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "initial_cells": [{"cell_type": "markdown", "content": {"content": "An example timeline cell message."}, "important": false}], "notification_handles": [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}], "title": "A test incident title"}, "relationships": {"commander_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}}
+    And body with value {"data": {"attributes": {"customer_impact_scope": "Example customer impact scope", "customer_impacted": false, "fields": {"severity": {"type": "dropdown", "value": "SEV-5"}}, "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "initial_cells": [{"cell_type": "markdown", "content": {"content": "An example timeline cell message."}, "important": false}], "is_test": false, "notification_handles": [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}], "title": "A test incident title"}, "relationships": {"commander_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}}
     When the request is sent
     Then the response status is 400 Bad Request
 
@@ -89,7 +89,7 @@ Feature: Incidents
   Scenario: Create an incident returns "Not Found" response
     Given operation "CreateIncident" enabled
     And new "CreateIncident" request
-    And body with value {"data": {"attributes": {"customer_impact_scope": "Example customer impact scope", "customer_impacted": false, "fields": {"severity": {"type": "dropdown", "value": "SEV-5"}}, "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "initial_cells": [{"cell_type": "markdown", "content": {"content": "An example timeline cell message."}, "important": false}], "notification_handles": [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}], "title": "A test incident title"}, "relationships": {"commander_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}}
+    And body with value {"data": {"attributes": {"customer_impact_scope": "Example customer impact scope", "customer_impacted": false, "fields": {"severity": {"type": "dropdown", "value": "SEV-5"}}, "incident_type_uuid": "00000000-0000-0000-0000-000000000000", "initial_cells": [{"cell_type": "markdown", "content": {"content": "An example timeline cell message."}, "important": false}], "is_test": false, "notification_handles": [{"display_name": "Jane Doe", "handle": "@user@email.com"}, {"display_name": "Slack Channel", "handle": "@slack-channel"}, {"display_name": "Incident Workflow", "handle": "@workflow-from-incident"}], "title": "A test incident title"}, "relationships": {"commander_user": {"data": {"id": "00000000-0000-0000-0000-000000000000", "type": "users"}}}, "type": "incidents"}}
     When the request is sent
     Then the response status is 404 Not Found
 

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2025-06-25 17:36:53.162860",`
`8`		`- "spec_repo_commit": "51c17453"`
	`7`	`+ "regenerated": "2025-06-25 21:28:44.094918",`
	`8`	`+ "spec_repo_commit": "31044eb9"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-06-25 17:36:53.178661",`
`13`		`- "spec_repo_commit": "51c17453"`
	`12`	`+ "regenerated": "2025-06-25 21:28:44.111040",`
	`13`	`+ "spec_repo_commit": "31044eb9"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`