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

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-02-08 15:58:24.499672",
-            "spec_repo_commit": "7c0c43cc"
+            "regenerated": "2023-02-08 16:22:44.829792",
+            "spec_repo_commit": "c826f5c2"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-02-08 15:58:24.511994",
-            "spec_repo_commit": "7c0c43cc"
+            "regenerated": "2023-02-08 16:22:44.841610",
+            "spec_repo_commit": "c826f5c2"
         }
     }
 }

.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

cassettes/features/v1/dashboards/Create-a-new-dashboard-with-event-stream-list-stream-widget.frozen

@@ -0,0 +1 @@
+2023-02-08T16:18:06.266Z

cassettes/features/v1/dashboards/Create-a-new-dashboard-with-event-stream-list-stream-widget.yml

@@ -0,0 +1,33 @@
+# Create a new dashboard with event_stream list_stream widget
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V1::DashboardsAPI.new
+
+body = DatadogAPIClient::V1::Dashboard.new({
+  layout_type: DatadogAPIClient::V1::DashboardLayoutType::ORDERED,
+  title: "Example-Create_a_new_dashboard_with_event_stream_list_stream_widget with list_stream widget",
+  widgets: [
+    DatadogAPIClient::V1::Widget.new({
+      definition: DatadogAPIClient::V1::ListStreamWidgetDefinition.new({
+        type: DatadogAPIClient::V1::ListStreamWidgetDefinitionType::LIST_STREAM,
+        requests: [
+          DatadogAPIClient::V1::ListStreamWidgetRequest.new({
+            columns: [
+              DatadogAPIClient::V1::ListStreamColumn.new({
+                width: DatadogAPIClient::V1::ListStreamColumnWidth::AUTO,
+                field: "timestamp",
+              }),
+            ],
+            query: DatadogAPIClient::V1::ListStreamQuery.new({
+              data_source: DatadogAPIClient::V1::ListStreamSource::EVENT_STREAM,
+              query_string: "",
+              event_size: DatadogAPIClient::V1::WidgetEventSize::LARGE,
+            }),
+            response_format: DatadogAPIClient::V1::ListStreamResponseFormat::EVENT_LIST,
+          }),
+        ],
+      }),
+    }),
+  ],
+})
+p api_instance.create_dashboard(body)

examples/v1/dashboards/CreateDashboard_2432046716.rb

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

features/v1/dashboards.feature

@@ -31,6 +31,9 @@ class ListStreamQuery
     # Source from which to query items to display in the stream.
     attr_reader :data_source
 
+    # Size to use to display an event.
+    attr_accessor :event_size
+
     # 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.
     attr_reader :group_by
 
@@ -49,6 +52,7 @@ def self.attribute_map
       {
         :'compute' => :'compute',
         :'data_source' => :'data_source',
+        :'event_size' => :'event_size',
         :'group_by' => :'group_by',
         :'indexes' => :'indexes',
         :'query_string' => :'query_string',
@@ -62,6 +66,7 @@ def self.openapi_types
       {
         :'compute' => :'Array<ListStreamComputeItems>',
         :'data_source' => :'ListStreamSource',
+        :'event_size' => :'WidgetEventSize',
         :'group_by' => :'Array<ListStreamGroupByItems>',
         :'indexes' => :'Array<String>',
         :'query_string' => :'String',
@@ -95,6 +100,10 @@ def initialize(attributes = {})
         self.data_source = attributes[:'data_source']
       end
 
+      if attributes.key?(:'event_size')
+        self.event_size = attributes[:'event_size']
+      end
+
       if attributes.key?(:'group_by')
         if (value = attributes[:'group_by']).is_a?(Array)
           self.group_by = value
@@ -179,6 +188,7 @@ def ==(o)
       self.class == o.class &&
           compute == o.compute &&
           data_source == o.data_source &&
+          event_size == o.event_size &&
           group_by == o.group_by &&
           indexes == o.indexes &&
           query_string == o.query_string &&
@@ -189,7 +199,7 @@ def ==(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [compute, data_source, group_by, indexes, query_string, storage].hash
+      [compute, data_source, event_size, group_by, indexes, query_string, storage].hash
     end
   end
 end

lib/datadog_api_client/v1/models/list_stream_query.rb

@@ -27,5 +27,6 @@ class ListStreamSource
     APM_ISSUE_STREAM = "apm_issue_stream".freeze
     LOGS_PATTERN_STREAM = "logs_pattern_stream".freeze
     LOGS_TRANSACTION_STREAM = "logs_transaction_stream".freeze
+    EVENT_STREAM = "event_stream".freeze
   end
 end