Add show_year option for event list widget (#1154)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-24 13:15:52.349852",
-            "spec_repo_commit": "61d57b72"
+            "regenerated": "2023-05-24 14:20:11.109038",
+            "spec_repo_commit": "89276ce5"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-24 13:15:52.364402",
-            "spec_repo_commit": "61d57b72"
+            "regenerated": "2023-05-24 14:20:11.121453",
+            "spec_repo_commit": "89276ce5"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -4289,6 +4289,10 @@ components:
           description: Widget query.
           example: '@service:app'
           type: string
+        show_year:
+          description: Option to display the year in the date column. To be used with
+            the `event_stream`.
+          type: boolean
         storage:
           description: Option for storage location. Feature in Private Beta.
           example: indexes

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/frozen.json

@@ -1 +1 @@
-"2023-02-08T16:18:06.266Z"
+"2023-05-23T16:19:21.371Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-list_stream-widget_4186303400/recording.har

@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "e13a56fb8e7ecc8fcccd1dc11cfaf098",
+        "_id": "3b2bfad3f58d6875c744251ff9e36f51",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 354,
+          "bodySize": 371,
           "cookies": [],
           "headers": [
             {
@@ -26,23 +26,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 559,
+          "headersSize": 557,
           "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\"}}]}"
+            "text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_list_stream_widget-1684858761 with list_stream widget\",\"widgets\":[{\"definition\":{\"requests\":[{\"columns\":[{\"field\":\"timestamp\",\"width\":\"auto\"}],\"query\":{\"data_source\":\"event_stream\",\"event_size\":\"l\",\"query_string\":\"\",\"show_year\":true},\"response_format\":\"event_list\"}],\"type\":\"list_stream\"}}]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/dashboard"
         },
         "response": {
-          "bodySize": 768,
+          "bodySize": 785,
           "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\":\"[email protected]\",\"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"
+            "size": 785,
+            "text": "{\"id\":\"s56-ph7-gmi\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_list_stream_widget-1684858761 with list_stream widget\",\"description\":null,\"author_handle\":\"[email protected]\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/s56-ph7-gmi/test-createanewdashboardwitheventstreamliststreamwidget-1684858761-with-liststre\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"requests\":[{\"columns\":[{\"field\":\"timestamp\",\"width\":\"auto\"}],\"query\":{\"data_source\":\"event_stream\",\"event_size\":\"l\",\"query_string\":\"\",\"show_year\":true},\"response_format\":\"event_list\"}],\"type\":\"list_stream\"},\"id\":3197043212239739}],\"notify_list\":null,\"created_at\":\"2023-05-23T16:19:21.576643+00:00\",\"modified_at\":\"2023-05-23T16:19:21.576643+00:00\",\"restricted_roles\":[]}\n"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 490,
+          "headersSize": 517,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2023-02-08T16:18:06.275Z",
-        "time": 272
+        "startedDateTime": "2023-05-23T16:19:21.388Z",
+        "time": 246
       },
       {
-        "_id": "ee1b2016b8d93d3f4959f703304bf7c6",
+        "_id": "a93850478692fdce320fae4670782faa",
         "_order": 0,
         "cache": {},
         "request": {
@@ -74,18 +74,18 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 520,
+          "headersSize": 518,
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/dashboard/zmh-rud-g4b"
+          "url": "https://api.datadoghq.com/api/v1/dashboard/s56-ph7-gmi"
         },
         "response": {
           "bodySize": 39,
           "content": {
             "mimeType": "application/json",
             "size": 39,
-            "text": "{\"deleted_dashboard_id\":\"zmh-rud-g4b\"}\n"
+            "text": "{\"deleted_dashboard_id\":\"s56-ph7-gmi\"}\n"
           },
           "cookies": [],
           "headers": [
@@ -94,14 +94,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 489,
+          "headersSize": 516,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2023-02-08T16:18:06.574Z",
-        "time": 215
+        "startedDateTime": "2023-05-23T16:19:21.645Z",
+        "time": 173
       }
     ],
     "pages": [],

examples/v1/dashboards/CreateDashboard_2432046716.ts

@@ -27,6 +27,7 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
                 dataSource: "event_stream",
                 queryString: "",
                 eventSize: "l",
+                showYear: true,
               },
               responseFormat: "event_list",
             },

features/v1/dashboards.feature

@@ -261,13 +261,14 @@ Feature: Dashboards
   @team:DataDog/dashboards-backend
   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"}]}}]}
+    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", "show_year": true},"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"
+    And the response "widgets[0].definition.requests[0].query.show_year" is equal to true
 
   @team:DataDog/dashboards-backend
   Scenario: Create a new dashboard with event_stream widget

packages/datadog-api-client-v1/models/ListStreamQuery.ts

@@ -38,6 +38,10 @@ export class ListStreamQuery {
    * Widget query.
    */
   "queryString": string;
+  /**
+   * Option to display the year in the date column. To be used with the `event_stream`.
+   */
+  "showYear"?: boolean;
   /**
    * Option for storage location. Feature in Private Beta.
    */
@@ -78,6 +82,10 @@ export class ListStreamQuery {
       type: "string",
       required: true,
     },
+    showYear: {
+      baseName: "show_year",
+      type: "boolean",
+    },
     storage: {
       baseName: "storage",
       type: "string",