Add show_year option for event list widget (#1477)

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:16:05.936665",
-            "spec_repo_commit": "61d57b72"
+            "regenerated": "2023-05-24 14:20:21.063926",
+            "spec_repo_commit": "89276ce5"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-24 13:16:06.032642",
-            "spec_repo_commit": "61d57b72"
+            "regenerated": "2023-05-24 14:20:21.079435",
+            "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

examples/v1/dashboards/CreateDashboard_2432046716.py

@@ -36,6 +36,7 @@
                             data_source=ListStreamSource.EVENT_STREAM,
                             query_string="",
                             event_size=WidgetEventSize.LARGE,
+                            show_year=True,
                         ),
                         response_format=ListStreamResponseFormat.EVENT_LIST,
                     ),

src/datadog_api_client/v1/model/list_stream_query.py

@@ -45,6 +45,7 @@ def openapi_types(_):
             "group_by": ([ListStreamGroupByItems],),
             "indexes": ([str],),
             "query_string": (str,),
+            "show_year": (bool,),
             "storage": (str,),
         }
 
@@ -55,6 +56,7 @@ def openapi_types(_):
         "group_by": "group_by",
         "indexes": "indexes",
         "query_string": "query_string",
+        "show_year": "show_year",
         "storage": "storage",
     }
 
@@ -66,6 +68,7 @@ def __init__(
         event_size: Union[WidgetEventSize, UnsetType] = unset,
         group_by: Union[List[ListStreamGroupByItems], UnsetType] = unset,
         indexes: Union[List[str], UnsetType] = unset,
+        show_year: Union[bool, UnsetType] = unset,
         storage: Union[str, UnsetType] = unset,
         **kwargs,
     ):
@@ -90,6 +93,9 @@ def __init__(
         :param query_string: Widget query.
         :type query_string: str
 
+        :param show_year: Option to display the year in the date column. To be used with the ``event_stream``.
+        :type show_year: bool, optional
+
         :param storage: Option for storage location. Feature in Private Beta.
         :type storage: str, optional
         """
@@ -101,6 +107,8 @@ def __init__(
             kwargs["group_by"] = group_by
         if indexes is not unset:
             kwargs["indexes"] = indexes
+        if show_year is not unset:
+            kwargs["show_year"] = show_year
         if storage is not unset:
             kwargs["storage"] = storage
         super().__init__(kwargs)

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_event_stream_list_stream_widget.frozen

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

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_event_stream_list_stream_widget.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
-    body: '{"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"}}]}'
+    body: '{"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"}}]}'
     headers:
       accept:
       - application/json
@@ -11,8 +11,8 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/dashboard
   response:
     body:
-      string: '{"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"}
+      string: '{"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":[]}
 
         '
     headers:
@@ -27,10 +27,10 @@ interactions:
       accept:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/dashboard/zmh-rud-g4b
+    uri: https://api.datadoghq.com/api/v1/dashboard/s56-ph7-gmi
   response:
     body:
-      string: '{"deleted_dashboard_id":"zmh-rud-g4b"}
+      string: '{"deleted_dashboard_id":"s56-ph7-gmi"}
 
         '
     headers:

tests/v1/features/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