Support incident_analytics enum in dashboard widget FormulaAndFunctionEventsDataSource data sources (#1719)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 9c57938c8306 · 2024-07-23T16:21:28.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-22 20:03:18.056182",
-            "spec_repo_commit": "cd020fa6"
+            "regenerated": "2024-07-23 15:33:50.395018",
+            "spec_repo_commit": "015355f6"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-07-22 20:03:18.075162",
-            "spec_repo_commit": "cd020fa6"
+            "regenerated": "2024-07-23 15:33:50.413026",
+            "spec_repo_commit": "015355f6"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -2867,6 +2867,7 @@ components:
       - events
       - ci_tests
       - ci_pipelines
+      - incident_analytics
       example: logs
       type: string
       x-enum-varnames:
@@ -2880,6 +2881,7 @@ components:
       - EVENTS
       - CI_TESTS
       - CI_PIPELINES
+      - INCIDENT_ANALYTICS
     FormulaAndFunctionMetricAggregation:
       description: The aggregation methods available for metrics queries.
       enum:
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-incident_analytics-data-source_707603316/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-incident_analytics-data-source_707603316/frozen.json
@@ -0,0 +1 @@
+"2024-07-23T14:59:59.215Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-incident_analytics-data-source_707603316/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-timeseries-widget-with-incident_analytics-data-source_707603316/recording.har
@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new timeseries widget with incident_analytics data source",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "7463bd2484f9696fa67b31568a8933fd",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 681,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 557,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_incident_analytics_data_source-1721746799 with incident_analytics datasource\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\"},\"data_source\":\"incident_analytics\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"test_level:test\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{},\"title\":\"\",\"type\":\"timeseries\"}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 1095,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1095,
+            "text": "{\"id\":\"r29-a2b-nhh\",\"title\":\"Test-Create_a_new_timeseries_widget_with_incident_analytics_data_source-1721746799 with incident_analytics datasource\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/r29-a2b-nhh/test-createanewtimeserieswidgetwithincidentanalyticsdatasource-1721746799-with-i\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\"},\"data_source\":\"incident_analytics\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"test_level:test\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{},\"title\":\"\",\"type\":\"timeseries\"},\"id\":4216078110414841}],\"notify_list\":null,\"created_at\":\"2024-07-23T14:59:59.491800+00:00\",\"modified_at\":\"2024-07-23T14:59:59.491800+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 657,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2024-07-23T14:59:59.224Z",
+        "time": 455
+      },
+      {
+        "_id": "f15c962c8f92d14962e29e114b20212d",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 518,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/r29-a2b-nhh"
+        },
+        "response": {
+          "bodySize": 39,
+          "content": {
+            "mimeType": "application/json",
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"r29-a2b-nhh\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 655,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2024-07-23T14:59:59.685Z",
+        "time": 222
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/dashboards/CreateDashboard_985012506.ts b/examples/v1/dashboards/CreateDashboard_985012506.ts
@@ -0,0 +1,67 @@
+/**
+ * Create a new timeseries widget with incident_analytics data source
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.DashboardsApi(configuration);
+
+const params: v1.DashboardsApiCreateDashboardRequest = {
+  body: {
+    title: "Example-Dashboard with incident_analytics datasource",
+    widgets: [
+      {
+        definition: {
+          title: "",
+          showLegend: true,
+          legendLayout: "auto",
+          legendColumns: ["avg", "min", "max", "value", "sum"],
+          time: {},
+          type: "timeseries",
+          requests: [
+            {
+              formulas: [
+                {
+                  formula: "query1",
+                },
+              ],
+              queries: [
+                {
+                  dataSource: "incident_analytics",
+                  name: "query1",
+                  search: {
+                    query: "test_level:test",
+                  },
+                  indexes: ["*"],
+                  compute: {
+                    aggregation: "count",
+                  },
+                  groupBy: [],
+                },
+              ],
+              responseFormat: "timeseries",
+              style: {
+                palette: "dog_classic",
+                lineType: "solid",
+                lineWidth: "normal",
+              },
+              displayType: "line",
+            },
+          ],
+        },
+      },
+    ],
+    layoutType: "ordered",
+    reflowType: "auto",
+  },
+};
+
+apiInstance
+  .createDashboard(params)
+  .then((data: v1.Dashboard) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));
diff --git a/features/v1/dashboards.feature b/features/v1/dashboards.feature
@@ -830,6 +830,15 @@ Feature: Dashboards
     And the response "widgets[0].definition.requests[0].queries[0].data_source" is equal to "ci_tests"
     And the response "widgets[0].definition.requests[0].queries[0].search.query" is equal to "test_level:test"
 
+  @team:DataDog/dashboards-backend
+  Scenario: Create a new timeseries widget with incident_analytics data source
+    Given new "CreateDashboard" request
+    And body with value {"title":"{{ unique }} with incident_analytics datasource","widgets":[{"definition":{"title":"","show_legend":true,"legend_layout":"auto","legend_columns":["avg","min","max","value","sum"],"time":{},"type":"timeseries","requests":[{"formulas":[{"formula":"query1"}],"queries":[{"data_source":"incident_analytics","name":"query1","search":{"query":"test_level:test"},"indexes":["*"],"compute":{"aggregation":"count"},"group_by":[]}],"response_format":"timeseries","style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]}}],"layout_type":"ordered","reflow_type":"auto"}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "widgets[0].definition.requests[0].queries[0].data_source" is equal to "incident_analytics"
+    And the response "widgets[0].definition.requests[0].queries[0].search.query" is equal to "test_level:test"
+
   @generated @skip @team:DataDog/dashboards-backend
   Scenario: Create a shared dashboard returns "Bad Request" response
     Given new "CreatePublicDashboard" request
diff --git a/packages/datadog-api-client-v1/models/FormulaAndFunctionEventsDataSource.ts b/packages/datadog-api-client-v1/models/FormulaAndFunctionEventsDataSource.ts
@@ -21,6 +21,7 @@ export type FormulaAndFunctionEventsDataSource =
   | typeof EVENTS
   | typeof CI_TESTS
   | typeof CI_PIPELINES
+  | typeof INCIDENT_ANALYTICS
   | UnparsedObject;
 export const LOGS = "logs";
 export const SPANS = "spans";
@@ -32,3 +33,4 @@ export const AUDIT = "audit";
 export const EVENTS = "events";
 export const CI_TESTS = "ci_tests";
 export const CI_PIPELINES = "ci_pipelines";
+export const INCIDENT_ANALYTICS = "incident_analytics";
diff --git a/packages/datadog-api-client-v1/models/ObjectSerializer.ts b/packages/datadog-api-client-v1/models/ObjectSerializer.ts
@@ -732,6 +732,7 @@ const enumsMap: { [key: string]: any[] } = {
     "events",
     "ci_tests",
     "ci_pipelines",
+    "incident_analytics",
   ],
   FormulaAndFunctionMetricAggregation: [
     "avg",

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": "2024-07-22 20:03:18.056182",`
`8`		`- "spec_repo_commit": "cd020fa6"`
	`7`	`+ "regenerated": "2024-07-23 15:33:50.395018",`
	`8`	`+ "spec_repo_commit": "015355f6"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-07-22 20:03:18.075162",`
`13`		`- "spec_repo_commit": "cd020fa6"`
	`12`	`+ "regenerated": "2024-07-23 15:33:50.413026",`
	`13`	`+ "spec_repo_commit": "015355f6"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`