Update widget's properties' description (#1428)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v1/openapi.yaml

@@ -3368,8 +3368,10 @@ components:
       x-enum-varnames:
         - FORMULA
     FreeTextWidgetDefinition:
-      description: Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
+      description: Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
       properties:
+        background_color:
+          $ref: "#/components/schemas/WidgetBackgroundColor"
         color:
           description: Color of the text.
           type: string
@@ -3810,11 +3812,10 @@ components:
       x-enum-varnames:
         - GROUP
     GroupWidgetDefinition:
-      description: The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
+      description: The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
       properties:
         background_color:
-          description: Background color of the group title.
-          type: string
+          $ref: "#/components/schemas/WidgetBackgroundColor"
         banner_img:
           description: URL of image to display as a banner for the group.
           type: string
@@ -4672,7 +4673,7 @@ components:
         - VULN_MANAGEMENT_HOSTS_USAGE
         - WORKFLOW_EXECUTIONS_USAGE
     IFrameWidgetDefinition:
-      description: The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
+      description: The iframe widget allows you to embed a portion of any other web page on your dashboard.
       properties:
         type:
           $ref: "#/components/schemas/IFrameWidgetDefinitionType"
@@ -4944,7 +4945,7 @@ components:
         - message
       type: object
     ImageWidgetDefinition:
-      description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
+      description: The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
       properties:
         has_background:
           default: true
@@ -5345,7 +5346,7 @@ components:
         - query
       type: object
     LogStreamWidgetDefinition:
-      description: The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
+      description: The Log Stream displays a log flow matching the defined query.
       properties:
         columns:
           description: Which columns to display on the widget.
@@ -8766,7 +8767,7 @@ components:
           $ref: "#/components/schemas/MonitorOverallStates"
       type: object
     MonitorSummaryWidgetDefinition:
-      description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
+      description: The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
       properties:
         color_preference:
           $ref: "#/components/schemas/WidgetColorPreference"
@@ -12897,7 +12898,7 @@ components:
         - METRIC
         - TIME_SLICE
     SLOWidgetDefinition:
-      description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
+      description: Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
       properties:
         additional_query_filters:
           description: Additional filters applied to the SLO query.
@@ -14108,7 +14109,7 @@ components:
       x-enum-varnames:
         - SERVICEMAP
     ServiceSummaryWidgetDefinition:
-      description: The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
+      description: The service summary displays the graphs of a chosen service in your dashboard.
       properties:
         description:
           description: The description of the widget.
@@ -18657,7 +18658,7 @@ components:
         - BAR
         - TREND
     TableWidgetDefinition:
-      description: The table visualization is available on timeboards and screenboards. It displays columns of metrics grouped by tag key.
+      description: The table visualization is available on dashboards. It displays columns of metrics grouped by tag key.
       properties:
         custom_links:
           description: List of custom links.
@@ -24139,6 +24140,9 @@ components:
           description: Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
           type: string
       type: object
+    WidgetBackgroundColor:
+      description: "Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`."
+      type: string
     WidgetChangeType:
       description: Show the absolute or the relative change.
       enum:

src/datadogV1/model/model_free_text_widget_definition.rs

@@ -6,11 +6,14 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// Free text is a widget that allows you to add headings to your screenboard. Commonly used to state the overall purpose of the dashboard. Only available on FREE layout dashboards.
+/// Free text is a widget that allows you to add headings to your dashboard. Commonly used to state the overall purpose of the dashboard.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct FreeTextWidgetDefinition {
+    /// Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`.
+    #[serde(rename = "background_color")]
+    pub background_color: Option<String>,
     /// Color of the text.
     #[serde(rename = "color")]
     pub color: Option<String>,
@@ -39,6 +42,7 @@ impl FreeTextWidgetDefinition {
         type_: crate::datadogV1::model::FreeTextWidgetDefinitionType,
     ) -> FreeTextWidgetDefinition {
         FreeTextWidgetDefinition {
+            background_color: None,
             color: None,
             font_size: None,
             text,
@@ -49,6 +53,11 @@ impl FreeTextWidgetDefinition {
         }
     }
 
+    pub fn background_color(mut self, value: String) -> Self {
+        self.background_color = Some(value);
+        self
+    }
+
     pub fn color(mut self, value: String) -> Self {
         self.color = Some(value);
         self
@@ -90,6 +99,7 @@ impl<'de> Deserialize<'de> for FreeTextWidgetDefinition {
             where
                 M: MapAccess<'a>,
             {
+                let mut background_color: Option<String> = None;
                 let mut color: Option<String> = None;
                 let mut font_size: Option<String> = None;
                 let mut text: Option<String> = None;
@@ -103,6 +113,13 @@ impl<'de> Deserialize<'de> for FreeTextWidgetDefinition {
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
+                        "background_color" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            background_color =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "color" => {
                             if v.is_null() {
                                 continue;
@@ -156,6 +173,7 @@ impl<'de> Deserialize<'de> for FreeTextWidgetDefinition {
                 let type_ = type_.ok_or_else(|| M::Error::missing_field("type_"))?;
 
                 let content = FreeTextWidgetDefinition {
+                    background_color,
                     color,
                     font_size,
                     text,

src/datadogV1/model/model_group_widget_definition.rs

@@ -6,12 +6,12 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The groups widget allows you to keep similar graphs together on your timeboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
+/// The group widget allows you to keep similar graphs together on your dashboard. Each group has a custom header, can hold one to many graphs, and is collapsible.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct GroupWidgetDefinition {
-    /// Background color of the group title.
+    /// Background color of the widget. Supported values are `white`, `blue`, `purple`, `pink`, `orange`, `yellow`, `green`, `gray`, `vivid_blue`, `vivid_purple`, `vivid_pink`, `vivid_orange`, `vivid_yellow`, `vivid_green`, and `transparent`.
     #[serde(rename = "background_color")]
     pub background_color: Option<String>,
     /// URL of image to display as a banner for the group.

src/datadogV1/model/model_i_frame_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The iframe widget allows you to embed a portion of any other web page on your dashboard. Only available on FREE layout dashboards.
+/// The iframe widget allows you to embed a portion of any other web page on your dashboard.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_image_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF. Only available on FREE layout dashboards.
+/// The image widget allows you to embed an image on your dashboard. An image can be a PNG, JPG, or animated GIF.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_log_stream_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
+/// The Log Stream displays a log flow matching the defined query.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_monitor_summary_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query. Only available on FREE layout dashboards.
+/// The monitor summary widget displays a summary view of all your Datadog monitors, or a subset based on a query.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_notebook_log_stream_cell_attributes.rs

@@ -11,7 +11,7 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct NotebookLogStreamCellAttributes {
-    /// The Log Stream displays a log flow matching the defined query. Only available on FREE layout dashboards.
+    /// The Log Stream displays a log flow matching the defined query.
     #[serde(rename = "definition")]
     pub definition: crate::datadogV1::model::LogStreamWidgetDefinition,
     /// The size of the graph.

src/datadogV1/model/model_service_summary_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// The service summary displays the graphs of a chosen service in your screenboard. Only available on FREE layout dashboards.
+/// The service summary displays the graphs of a chosen service in your dashboard.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]

src/datadogV1/model/model_slo_widget_definition.rs

@@ -6,7 +6,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 use serde_with::skip_serializing_none;
 use std::fmt::{self, Formatter};
 
-/// Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on screenboards and timeboards.
+/// Use the SLO and uptime widget to track your SLOs (Service Level Objectives) and uptime on dashboards.
 #[non_exhaustive]
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]