Add show_year option for event stream widget (#1468)

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-17 20:57:57.889792",
-            "spec_repo_commit": "d8186149"
+            "regenerated": "2023-05-19 14:45:10.283637",
+            "spec_repo_commit": "937a9438"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-05-17 20:57:57.901737",
-            "spec_repo_commit": "d8186149"
+            "regenerated": "2023-05-19 14:45:10.295797",
+            "spec_repo_commit": "937a9438"
         }
     }
 }

.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.

examples/v1/dashboards/CreateDashboard_2634813877.py

@@ -32,6 +32,7 @@
                 query="example-query",
                 tags_execution="and",
                 event_size=WidgetEventSize.SMALL,
+                show_year=True,
             ),
         ),
     ],

src/datadog_api_client/v1/model/event_stream_widget_definition.py

@@ -31,6 +31,7 @@ def openapi_types(_):
         return {
             "event_size": (WidgetEventSize,),
             "query": (str,),
+            "show_year": (bool,),
             "tags_execution": (str,),
             "time": (WidgetTime,),
             "title": (str,),
@@ -42,6 +43,7 @@ def openapi_types(_):
     attribute_map = {
         "event_size": "event_size",
         "query": "query",
+        "show_year": "show_year",
         "tags_execution": "tags_execution",
         "time": "time",
         "title": "title",
@@ -55,6 +57,7 @@ def __init__(
         query: str,
         type: EventStreamWidgetDefinitionType,
         event_size: Union[WidgetEventSize, UnsetType] = unset,
+        show_year: Union[bool, UnsetType] = unset,
         tags_execution: Union[str, UnsetType] = unset,
         time: Union[WidgetTime, UnsetType] = unset,
         title: Union[str, UnsetType] = unset,
@@ -72,6 +75,9 @@ def __init__(
         :param query: Query to filter the event stream with.
         :type query: str
 
+        :param show_year: Option to display the year in the date column.
+        :type show_year: bool, optional
+
         :param tags_execution: The execution method for multi-value filters. Can be either and or or.
         :type tags_execution: str, optional
 
@@ -92,6 +98,8 @@ def __init__(
         """
         if event_size is not unset:
             kwargs["event_size"] = event_size
+        if show_year is not unset:
+            kwargs["show_year"] = show_year
         if tags_execution is not unset:
             kwargs["tags_execution"] = tags_execution
         if time is not unset:

src/datadog_api_client/v1/model/widget_definition.py

@@ -90,6 +90,9 @@ def __init__(self, **kwargs):
         :param query: Query to filter the event stream with.
         :type query: str
 
+        :param show_year: Option to display the year in the date column.
+        :type show_year: bool, optional
+
         :param tags_execution: The execution method for multi-value filters. Can be either and or or.
         :type tags_execution: str, optional
 

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_event_stream_widget.frozen

@@ -1 +1 @@
-2022-01-06T00:50:30.857Z
+2023-05-19T14:24:41.183Z

tests/v1/cassettes/test_scenarios/test_create_a_new_dashboard_with_event_stream_widget.yaml

@@ -1,6 +1,6 @@
 interactions:
 - request:
-    body: '{"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}}]}'
+    body: '{"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}}]}'
     headers:
       accept:
       - application/json
@@ -10,7 +10,9 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/dashboard
   response:
     body:
-      string: '{"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":"[email protected]","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"}'
+      string: '{"id":"6fx-j89-9ip","title":"Test-Create_a_new_dashboard_with_event_stream_widget-1684506281","description":"","author_handle":"[email protected]","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":[]}
+
+        '
     headers:
       content-type:
       - application/json
@@ -23,10 +25,12 @@ interactions:
       accept:
       - application/json
     method: DELETE
-    uri: https://api.datadoghq.com/api/v1/dashboard/2dc-bzm-gzi
+    uri: https://api.datadoghq.com/api/v1/dashboard/6fx-j89-9ip
   response:
     body:
-      string: '{"deleted_dashboard_id":"2dc-bzm-gzi"}'
+      string: '{"deleted_dashboard_id":"6fx-j89-9ip"}
+
+        '
     headers:
       content-type:
       - application/json

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

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