Add event_stream fields to dashboard list stream widget (#1011)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit cfdc3019174e · 2023-02-08T16:31:11.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.4",
-            "regenerated": "2023-02-08 15:58:27.051159",
-            "spec_repo_commit": "7c0c43cc"
+            "regenerated": "2023-02-08 16:22:59.782448",
+            "spec_repo_commit": "c826f5c2"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-08 15:58:27.063520",
-            "spec_repo_commit": "7c0c43cc"
+            "regenerated": "2023-02-08 16:22:59.797784",
+            "spec_repo_commit": "c826f5c2"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -4078,6 +4078,8 @@ components:
           type: array
         data_source:
           $ref: '#/components/schemas/ListStreamSource'
+        event_size:
+          $ref: '#/components/schemas/WidgetEventSize'
         group_by:
           description: Group by configuration for the List Stream Widget. Group by
             can be used only with logs_pattern_stream (up to 3 items) or logs_transaction_stream
@@ -4122,6 +4124,7 @@ components:
       - apm_issue_stream
       - logs_pattern_stream
       - logs_transaction_stream
+      - event_stream
       example: apm_issue_stream
       type: string
       x-enum-varnames:
@@ -4131,6 +4134,7 @@ components:
       - APM_ISSUE_STREAM
       - LOGS_PATTERN_STREAM
       - LOGS_TRANSACTION_STREAM
+      - EVENT_STREAM
     ListStreamWidgetDefinition:
       description: 'The list stream visualization displays a table of recent events
         in your application that
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/frozen.json
@@ -0,0 +1 @@
+"2023-02-08T16:18:06.266Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/recording.har
@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with event_stream list_stream widget",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "e13a56fb8e7ecc8fcccd1dc11cfaf098",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 354,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 559,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_list_stream_widget-1675873086 with list_stream widget\",\"widgets\":[{\"definition\":{\"requests\":[{\"columns\":[{\"field\":\"timestamp\",\"width\":\"auto\"}],\"query\":{\"data_source\":\"event_stream\",\"event_size\":\"l\",\"query_string\":\"\"},\"response_format\":\"event_list\"}],\"type\":\"list_stream\"}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 768,
+          "content": {
+            "mimeType": "application/json",
+            "size": 768,
+            "text": "{\"notify_list\":null,\"description\":null,\"restricted_roles\":[],\"author_name\":null,\"template_variables\":null,\"is_read_only\":false,\"id\":\"zmh-rud-g4b\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_list_stream_widget-1675873086 with list_stream widget\",\"url\":\"/dashboard/zmh-rud-g4b/test-createanewdashboardwitheventstreamliststreamwidget-1675873086-with-liststre\",\"created_at\":\"2023-02-08T16:18:06.512655+00:00\",\"modified_at\":\"2023-02-08T16:18:06.512655+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"requests\":[{\"query\":{\"query_string\":\"\",\"data_source\":\"event_stream\",\"event_size\":\"l\"},\"response_format\":\"event_list\",\"columns\":[{\"field\":\"timestamp\",\"width\":\"auto\"}]}],\"type\":\"list_stream\"},\"id\":3303593204363469}],\"layout_type\":\"ordered\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 490,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-08T16:18:06.275Z",
+        "time": 272
+      },
+      {
+        "_id": "ee1b2016b8d93d3f4959f703304bf7c6",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 520,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/zmh-rud-g4b"
+        },
+        "response": {
+          "bodySize": 39,
+          "content": {
+            "mimeType": "application/json",
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"zmh-rud-g4b\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 489,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2023-02-08T16:18:06.574Z",
+        "time": 215
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/dashboards/CreateDashboard_2432046716.ts b/examples/v1/dashboards/CreateDashboard_2432046716.ts
@@ -0,0 +1,48 @@
+/**
+ * Create a new dashboard with event_stream list_stream widget
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.DashboardsApi(configuration);
+
+const params: v1.DashboardsApiCreateDashboardRequest = {
+  body: {
+    layoutType: "ordered",
+    title:
+      "Example-Create_a_new_dashboard_with_event_stream_list_stream_widget with list_stream widget",
+    widgets: [
+      {
+        definition: {
+          type: "list_stream",
+          requests: [
+            {
+              columns: [
+                {
+                  width: "auto",
+                  field: "timestamp",
+                },
+              ],
+              query: {
+                dataSource: "event_stream",
+                queryString: "",
+                eventSize: "l",
+              },
+              responseFormat: "event_list",
+            },
+          ],
+        },
+      },
+    ],
+  },
+};
+
+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
@@ -204,6 +204,17 @@ Feature: Dashboards
     And the response "widgets[0].definition.requests[0].apm_stats_query.service" is equal to "cassandra"
     And the response "widgets[0].definition.requests[0].apm_stats_query.name" is equal to "cassandra.query"
 
+  @team:DataDog/dashboards
+  Scenario: Create a new dashboard with event_stream list_stream widget
+    Given new "CreateDashboard" request
+    And body with value {"layout_type": "ordered","title": "{{ unique }} with list_stream widget","widgets": [{"definition": {"type": "list_stream","requests": [{"columns": [{"width": "auto","field": "timestamp"}],"query": {"data_source": "event_stream","query_string": "","event_size": "l"},"response_format": "event_list"}]}}]}
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "widgets[0].definition.type" is equal to "list_stream"
+    And the response "widgets[0].definition.requests[0].response_format" is equal to "event_list"
+    And the response "widgets[0].definition.requests[0].query.data_source" is equal to "event_stream"
+    And the response "widgets[0].definition.requests[0].query.event_size" is equal to "l"
+
   @team:DataDog/dashboards
   Scenario: Create a new dashboard with event_stream widget
     Given new "CreateDashboard" request
diff --git a/packages/datadog-api-client-v1/models/ListStreamQuery.ts b/packages/datadog-api-client-v1/models/ListStreamQuery.ts
@@ -6,6 +6,7 @@
 import { ListStreamComputeItems } from "./ListStreamComputeItems";
 import { ListStreamGroupByItems } from "./ListStreamGroupByItems";
 import { ListStreamSource } from "./ListStreamSource";
+import { WidgetEventSize } from "./WidgetEventSize";
 
 import { AttributeTypeMap } from "../../datadog-api-client-common/util";
 
@@ -21,6 +22,10 @@ export class ListStreamQuery {
    * Source from which to query items to display in the stream.
    */
   "dataSource": ListStreamSource;
+  /**
+   * Size to use to display an event.
+   */
+  "eventSize"?: WidgetEventSize;
   /**
    * Group by configuration for the List Stream Widget. Group by can be used only with logs_pattern_stream (up to 3 items) or logs_transaction_stream (one group by item is required) list stream source.
    */
@@ -56,6 +61,10 @@ export class ListStreamQuery {
       type: "ListStreamSource",
       required: true,
     },
+    eventSize: {
+      baseName: "event_size",
+      type: "WidgetEventSize",
+    },
     groupBy: {
       baseName: "group_by",
       type: "Array<ListStreamGroupByItems>",
diff --git a/packages/datadog-api-client-v1/models/ListStreamSource.ts b/packages/datadog-api-client-v1/models/ListStreamSource.ts
@@ -17,10 +17,12 @@ export type ListStreamSource =
   | typeof APM_ISSUE_STREAM
   | typeof LOGS_PATTERN_STREAM
   | typeof LOGS_TRANSACTION_STREAM
+  | typeof EVENT_STREAM
   | UnparsedObject;
 export const LOGS_STREAM = "logs_stream";
 export const AUDIT_STREAM = "audit_stream";
 export const RUM_ISSUE_STREAM = "rum_issue_stream";
 export const APM_ISSUE_STREAM = "apm_issue_stream";
 export const LOGS_PATTERN_STREAM = "logs_pattern_stream";
 export const LOGS_TRANSACTION_STREAM = "logs_transaction_stream";
+export const EVENT_STREAM = "event_stream";
diff --git a/packages/datadog-api-client-v1/models/ObjectSerializer.ts b/packages/datadog-api-client-v1/models/ObjectSerializer.ts
@@ -744,6 +744,7 @@ const enumsMap: { [key: string]: any[] } = {
     "apm_issue_stream",
     "logs_pattern_stream",
     "logs_transaction_stream",
+    "event_stream",
   ],
   ListStreamWidgetDefinitionType: ["list_stream"],
   LogStreamWidgetDefinitionType: ["log_stream"],

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.4",`
`7`		`- "regenerated": "2023-02-08 15:58:27.051159",`
`8`		`- "spec_repo_commit": "7c0c43cc"`
	`7`	`+ "regenerated": "2023-02-08 16:22:59.782448",`
	`8`	`+ "spec_repo_commit": "c826f5c2"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-02-08 15:58:27.063520",`
`13`		`- "spec_repo_commit": "7c0c43cc"`
	`12`	`+ "regenerated": "2023-02-08 16:22:59.797784",`
	`13`	`+ "spec_repo_commit": "c826f5c2"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`