Add show_year option for event stream widget (#1147)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit bd8d68319bd0 · 2023-05-19T15:12:01.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-05-17 20:58:15.183994",
-            "spec_repo_commit": "d8186149"
+            "regenerated": "2023-05-19 14:45:08.510425",
+            "spec_repo_commit": "937a9438"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-17 20:58:15.204157",
-            "spec_repo_commit": "d8186149"
+            "regenerated": "2023-05-19 14:45:08.523508",
+            "spec_repo_commit": "937a9438"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -2234,6 +2234,9 @@ components:
           description: Query to filter the event stream with.
           example: ''
           type: string
+        show_year:
+          description: Option to display the year in the date column.
+          type: boolean
         tags_execution:
           description: The execution method for multi-value filters. Can be either
             and or or.
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-widget_2820487547/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-widget_2820487547/frozen.json
@@ -1 +1 @@
-"2022-01-06T00:50:30.857Z"
+"2023-05-19T14:24:41.183Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-widget_2820487547/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-event_stream-widget_2820487547/recording.har
@@ -8,11 +8,11 @@
     },
     "entries": [
       {
-        "_id": "3879fec4f6fa1c422ce3f6a535a94a13",
+        "_id": "ed8b7422b62cf4715c891834a8c8a955",
         "_order": 0,
         "cache": {},
         "request": {
-          "bodySize": 386,
+          "bodySize": 403,
           "cookies": [],
           "headers": [
             {
@@ -26,23 +26,23 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 474,
+          "headersSize": 557,
           "httpVersion": "HTTP/1.1",
           "method": "POST",
           "postData": {
             "mimeType": "application/json",
             "params": [],
-            "text": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_event_stream_widget-1641430230\",\"widgets\":[{\"definition\":{\"event_size\":\"s\",\"query\":\"example-query\",\"tags_execution\":\"and\",\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"event_stream\"},\"layout\":{\"height\":38,\"width\":47,\"x\":0,\"y\":0}}]}"
+            "text": "{\"description\":\"\",\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_event_stream_widget-1684506281\",\"widgets\":[{\"definition\":{\"event_size\":\"s\",\"query\":\"example-query\",\"show_year\":true,\"tags_execution\":\"and\",\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"event_stream\"},\"layout\":{\"height\":38,\"width\":47,\"x\":0,\"y\":0}}]}"
           },
           "queryString": [],
           "url": "https://api.datadoghq.com/api/v1/dashboard"
         },
         "response": {
-          "bodySize": 690,
+          "bodySize": 708,
           "content": {
             "mimeType": "application/json",
-            "size": 690,
-            "text": "{\"notify_list\":[],\"description\":\"\",\"restricted_roles\":[],\"author_name\":null,\"template_variables\":[],\"is_read_only\":false,\"id\":\"2dc-bzm-gzi\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_widget-1641430230\",\"url\":\"/dashboard/2dc-bzm-gzi/test-createanewdashboardwitheventstreamwidget-1641430230\",\"created_at\":\"2022-01-06T00:50:31.037679+00:00\",\"modified_at\":\"2022-01-06T00:50:31.037679+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"title_size\":\"16\",\"title\":\"\",\"title_align\":\"left\",\"tags_execution\":\"and\",\"query\":\"example-query\",\"type\":\"event_stream\",\"event_size\":\"s\"},\"layout\":{\"y\":0,\"width\":47,\"x\":0,\"height\":38},\"id\":5676594590872385}],\"layout_type\":\"free\"}"
+            "size": 708,
+            "text": "{\"id\":\"6fx-j89-9ip\",\"title\":\"Test-Create_a_new_dashboard_with_event_stream_widget-1684506281\",\"description\":\"\",\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"free\",\"url\":\"/dashboard/6fx-j89-9ip/test-createanewdashboardwitheventstreamwidget-1684506281\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"event_size\":\"s\",\"query\":\"example-query\",\"show_year\":true,\"tags_execution\":\"and\",\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"event_stream\"},\"layout\":{\"height\":38,\"width\":47,\"x\":0,\"y\":0},\"id\":4666982916800865}],\"notify_list\":[],\"created_at\":\"2023-05-19T14:24:41.495188+00:00\",\"modified_at\":\"2023-05-19T14:24:41.495188+00:00\",\"restricted_roles\":[]}\n"
           },
           "cookies": [],
           "headers": [
@@ -51,17 +51,17 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 383,
+          "headersSize": 517,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-01-06T00:50:30.864Z",
-        "time": 275
+        "startedDateTime": "2023-05-19T14:24:41.201Z",
+        "time": 351
       },
       {
-        "_id": "ff9ac10a9fbffe0210a1d64f998e8483",
+        "_id": "c143cfa0caede40ec402fd1bd378319f",
         "_order": 0,
         "cache": {},
         "request": {
@@ -74,18 +74,18 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 435,
+          "headersSize": 519,
           "httpVersion": "HTTP/1.1",
           "method": "DELETE",
           "queryString": [],
-          "url": "https://api.datadoghq.com/api/v1/dashboard/2dc-bzm-gzi"
+          "url": "https://api.datadoghq.com/api/v1/dashboard/6fx-j89-9ip"
         },
         "response": {
-          "bodySize": 38,
+          "bodySize": 39,
           "content": {
             "mimeType": "application/json",
-            "size": 38,
-            "text": "{\"deleted_dashboard_id\":\"2dc-bzm-gzi\"}"
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"6fx-j89-9ip\"}\n"
           },
           "cookies": [],
           "headers": [
@@ -94,14 +94,14 @@
               "value": "application/json"
             }
           ],
-          "headersSize": 382,
+          "headersSize": 516,
           "httpVersion": "HTTP/1.1",
           "redirectURL": "",
           "status": 200,
           "statusText": "OK"
         },
-        "startedDateTime": "2022-01-06T00:50:31.147Z",
-        "time": 367
+        "startedDateTime": "2023-05-19T14:24:41.564Z",
+        "time": 269
       }
     ],
     "pages": [],
diff --git a/examples/v1/dashboards/CreateDashboard_2634813877.ts b/examples/v1/dashboards/CreateDashboard_2634813877.ts
@@ -27,6 +27,7 @@ const params: v1.DashboardsApiCreateDashboardRequest = {
           query: "example-query",
           tagsExecution: "and",
           eventSize: "s",
+          showYear: true,
         },
       },
     ],
diff --git a/features/v1/dashboards.feature b/features/v1/dashboards.feature
@@ -277,6 +277,7 @@ Feature: Dashboards
     Then the response status is 200 OK
     And the response "widgets[0].definition.type" is equal to "event_stream"
     And the response "widgets[0].definition.query" is equal to "example-query"
+    And the response "widgets[0].definition.show_year" is equal to true
 
   @team:DataDog/dashboards-backend
   Scenario: Create a new dashboard with event_timeline widget
diff --git a/features/v1/dashboards_json_payload/event_stream_widget.json b/features/v1/dashboards_json_payload/event_stream_widget.json
@@ -16,7 +16,8 @@
             "type":"event_stream",
             "query":"example-query",
             "tags_execution":"and",
-            "event_size":"s"
+            "event_size":"s",
+            "show_year": true
          }
       }
    ],
diff --git a/packages/datadog-api-client-v1/models/EventStreamWidgetDefinition.ts b/packages/datadog-api-client-v1/models/EventStreamWidgetDefinition.ts
@@ -23,6 +23,10 @@ export class EventStreamWidgetDefinition {
    * Query to filter the event stream with.
    */
   "query": string;
+  /**
+   * Option to display the year in the date column.
+   */
+  "showYear"?: boolean;
   /**
    * The execution method for multi-value filters. Can be either and or or.
    */
@@ -66,6 +70,10 @@ export class EventStreamWidgetDefinition {
       type: "string",
       required: true,
     },
+    showYear: {
+      baseName: "show_year",
+      type: "boolean",
+    },
     tagsExecution: {
       baseName: "tags_execution",
       type: "string",

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-05-17 20:58:15.183994",`
`8`		`- "spec_repo_commit": "d8186149"`
	`7`	`+ "regenerated": "2023-05-19 14:45:08.510425",`
	`8`	`+ "spec_repo_commit": "937a9438"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.4",`
`12`		`- "regenerated": "2023-05-17 20:58:15.204157",`
`13`		`- "spec_repo_commit": "d8186149"`
	`12`	`+ "regenerated": "2023-05-19 14:45:08.523508",`
	`13`	`+ "spec_repo_commit": "937a9438"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1 +1 @@`
`1`		`-"2022-01-06T00:50:30.857Z"`
	`1`	`+"2023-05-19T14:24:41.183Z"`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,8 @@`
`16`	`16`	`"type":"event_stream",`
`17`	`17`	`"query":"example-query",`
`18`	`18`	`"tags_execution":"and",`
`19`		`- "event_size":"s"`
	`19`	`+ "event_size":"s",`
	`20`	`+ "show_year": true`
`20`	`21`	`}`
`21`	`22`	`}`
`22`	`23`	`],`