docs(dataviz): update Treemap widget definition with deprecated properties + updated description [VIZZ-2305]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-07-19 07:52:50.122423",
-            "spec_repo_commit": "fd2aa418"
+            "regenerated": "2022-07-19 15:15:22.045487",
+            "spec_repo_commit": "d2c0157b"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-07-19 07:52:50.136121",
-            "spec_repo_commit": "fd2aa418"
+            "regenerated": "2022-07-19 15:15:22.084854",
+            "spec_repo_commit": "d2c0157b"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -13259,15 +13259,19 @@ components:
       type: object
     TreeMapColorBy:
       default: user
-      description: The attribute used to determine color in the widget.
+      deprecated: true
+      description: (deprecated) The attribute formerly used to determine color in
+        the widget.
       enum:
       - user
       example: user
       type: string
       x-enum-varnames:
       - USER
     TreeMapGroupBy:
-      description: The attribute used to group elements in the widget.
+      deprecated: true
+      description: (deprecated) The attribute formerly used to group elements in the
+        widget.
       enum:
       - user
       - family
@@ -13279,7 +13283,9 @@ components:
       - FAMILY
       - PROCESS
     TreeMapSizeBy:
-      description: The attribute used to determine size in the widget.
+      deprecated: true
+      description: (deprecated) The attribute formerly used to determine size in the
+        widget.
       enum:
       - pct_cpu
       - pct_mem
@@ -13289,27 +13295,35 @@ components:
       - PCT_CPU
       - PCT_MEM
     TreeMapWidgetDefinition:
-      description: "The treemap visualization found on the Host Dashboards comes from
-        the output of `ps auxww`. This is not continuously run on your hosts. Instead,
-        it\u2019s run once on Agent start/restart. The treemap is only supported for
-        process data on a single host dashboard \u2014 this may not be reused in other
-        dashboards or for other metrics."
+      description: The treemap visualization enables you to display hierarchical and
+        nested data. It is well suited for queries that describe part-whole relationships,
+        such as resource usage by availability zone, data center, or team.
       properties:
         color_by:
           $ref: '#/components/schemas/TreeMapColorBy'
+        custom_links:
+          description: List of custom links.
+          items:
+            $ref: '#/components/schemas/WidgetCustomLink'
+          type: array
         group_by:
           $ref: '#/components/schemas/TreeMapGroupBy'
         requests:
-          description: List of top list widget requests.
+          description: List of treemap widget requests.
           example:
-          - q: system.load.1
+          - aggregator: sum
+            data_source: metrics
+            name: query1
+            query: sum:system.mem.total{*} by {service}
           items:
             $ref: '#/components/schemas/TreeMapWidgetRequest'
           maxItems: 1
           minItems: 1
           type: array
         size_by:
           $ref: '#/components/schemas/TreeMapSizeBy'
+        time:
+          $ref: '#/components/schemas/WidgetTime'
         title:
           description: Title of your widget.
           type: string

lib/datadog_api_client/v1/models/tree_map_color_by.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V1
-  # The attribute used to determine color in the widget.
+  # (deprecated) The attribute formerly used to determine color in the widget.
   class TreeMapColorBy
     include BaseEnumModel
 

lib/datadog_api_client/v1/models/tree_map_group_by.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V1
-  # The attribute used to group elements in the widget.
+  # (deprecated) The attribute formerly used to group elements in the widget.
   class TreeMapGroupBy
     include BaseEnumModel
 

lib/datadog_api_client/v1/models/tree_map_size_by.rb

@@ -17,7 +17,7 @@
 require 'time'
 
 module DatadogAPIClient::V1
-  # The attribute used to determine size in the widget.
+  # (deprecated) The attribute formerly used to determine size in the widget.
   class TreeMapSizeBy
     include BaseEnumModel
 

lib/datadog_api_client/v1/models/tree_map_widget_definition.rb

@@ -17,26 +17,32 @@
 require 'time'
 
 module DatadogAPIClient::V1
-  # The treemap visualization found on the Host Dashboards comes from the output of `ps auxww`. This is not continuously run on your hosts. Instead, it’s run once on Agent start/restart. The treemap is only supported for process data on a single host dashboard — this may not be reused in other dashboards or for other metrics.
+  # The treemap visualization enables you to display hierarchical and nested data. It is well suited for queries that describe part-whole relationships, such as resource usage by availability zone, data center, or team.
   class TreeMapWidgetDefinition
     include BaseGenericModel
 
     # Whether the object has unparsed attributes
     # @!visibility private
     attr_accessor :_unparsed
 
-    # The attribute used to determine color in the widget.
+    # (deprecated) The attribute formerly used to determine color in the widget.
     attr_accessor :color_by
 
-    # The attribute used to group elements in the widget.
+    # List of custom links.
+    attr_accessor :custom_links
+
+    # (deprecated) The attribute formerly used to group elements in the widget.
     attr_accessor :group_by
 
-    # List of top list widget requests.
+    # List of treemap widget requests.
     attr_accessor :requests
 
-    # The attribute used to determine size in the widget.
+    # (deprecated) The attribute formerly used to determine size in the widget.
     attr_accessor :size_by
 
+    # Time setting for the widget.
+    attr_accessor :time
+
     # Title of your widget.
     attr_accessor :title
 
@@ -48,9 +54,11 @@ class TreeMapWidgetDefinition
     def self.attribute_map
       {
         :'color_by' => :'color_by',
+        :'custom_links' => :'custom_links',
         :'group_by' => :'group_by',
         :'requests' => :'requests',
         :'size_by' => :'size_by',
+        :'time' => :'time',
         :'title' => :'title',
         :'type' => :'type'
       }
@@ -67,9 +75,11 @@ def self.acceptable_attributes
     def self.openapi_types
       {
         :'color_by' => :'TreeMapColorBy',
+        :'custom_links' => :'Array<WidgetCustomLink>',
         :'group_by' => :'TreeMapGroupBy',
         :'requests' => :'Array<TreeMapWidgetRequest>',
         :'size_by' => :'TreeMapSizeBy',
+        :'time' => :'WidgetTime',
         :'title' => :'String',
         :'type' => :'TreeMapWidgetDefinitionType'
       }
@@ -104,6 +114,12 @@ def initialize(attributes = {})
         self.color_by = 'user'
       end
 
+      if attributes.key?(:'custom_links')
+        if (value = attributes[:'custom_links']).is_a?(Array)
+          self.custom_links = value
+        end
+      end
+
       if attributes.key?(:'group_by')
         self.group_by = attributes[:'group_by']
       end
@@ -118,6 +134,10 @@ def initialize(attributes = {})
         self.size_by = attributes[:'size_by']
       end
 
+      if attributes.key?(:'time')
+        self.time = attributes[:'time']
+      end
+
       if attributes.key?(:'title')
         self.title = attributes[:'title']
       end
@@ -173,9 +193,11 @@ def ==(o)
       return true if self.equal?(o)
       self.class == o.class &&
           color_by == o.color_by &&
+          custom_links == o.custom_links &&
           group_by == o.group_by &&
           requests == o.requests &&
           size_by == o.size_by &&
+          time == o.time &&
           title == o.title &&
           type == o.type
     end
@@ -191,7 +213,7 @@ def eql?(o)
     # @return [Integer] Hash code
     # @!visibility private
     def hash
-      [color_by, group_by, requests, size_by, title, type].hash
+      [color_by, custom_links, group_by, requests, size_by, time, title, type].hash
     end
   end
 end