Extend Widget time schema with support for hide_incomplete_cost_data (#874)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.generator/schemas/v1/openapi.yaml

@@ -24164,6 +24164,9 @@ components:
       additionalProperties: false
       description: Wrapper for live span
       properties:
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         live_span:
           $ref: '#/components/schemas/WidgetLiveSpan'
       type: object
@@ -24364,6 +24367,9 @@ components:
           format: int64
           minimum: 0
           type: integer
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         to:
           description: End time in seconds since epoch.
           example: 1712083128
@@ -24388,6 +24394,9 @@ components:
     WidgetNewLiveSpan:
       description: Used for arbitrary live span times, such as 17 minutes or 6 hours.
       properties:
+        hide_incomplete_cost_data:
+          description: Whether to hide incomplete cost data in the widget.
+          type: boolean
         type:
           $ref: '#/components/schemas/WidgetNewLiveSpanType'
         unit:

examples/v1_dashboards_CreateDashboard_3066042014.rs

@@ -94,7 +94,7 @@ async fn main() {
                                                 WidgetNewLiveSpanType::LIVE,
                                                 WidgetLiveSpanUnit::MINUTE,
                                                 8,
-                                            ),
+                                            ).hide_incomplete_cost_data(true),
                                         ),
                                     ),
                                 )

examples/v1_dashboards_CreateDashboard_3451918078.rs

@@ -93,7 +93,7 @@ async fn main() {
                                                 1712080128,
                                                 1712083128,
                                                 WidgetNewFixedSpanType::FIXED,
-                                            ),
+                                            ).hide_incomplete_cost_data(true),
                                         ),
                                     ),
                                 )

examples/v1_dashboards_CreateDashboard_4262729673.rs

@@ -89,7 +89,9 @@ async fn main() {
                                 .time(
                                     WidgetTime::WidgetLegacyLiveSpan(
                                         Box::new(
-                                            WidgetLegacyLiveSpan::new().live_span(WidgetLiveSpan::PAST_FIVE_MINUTES),
+                                            WidgetLegacyLiveSpan::new()
+                                                .hide_incomplete_cost_data(true)
+                                                .live_span(WidgetLiveSpan::PAST_FIVE_MINUTES),
                                         ),
                                     ),
                                 )

src/datadogV1/model/model_widget_legacy_live_span.rs

@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct WidgetLegacyLiveSpan {
+    /// Whether to hide incomplete cost data in the widget.
+    #[serde(rename = "hide_incomplete_cost_data")]
+    pub hide_incomplete_cost_data: Option<bool>,
     /// The available timeframes depend on the widget you are using.
     #[serde(rename = "live_span")]
     pub live_span: Option<crate::datadogV1::model::WidgetLiveSpan>,
@@ -22,11 +25,17 @@ pub struct WidgetLegacyLiveSpan {
 impl WidgetLegacyLiveSpan {
     pub fn new() -> WidgetLegacyLiveSpan {
         WidgetLegacyLiveSpan {
+            hide_incomplete_cost_data: None,
             live_span: None,
             _unparsed: false,
         }
     }
 
+    pub fn hide_incomplete_cost_data(mut self, value: bool) -> Self {
+        self.hide_incomplete_cost_data = Some(value);
+        self
+    }
+
     pub fn live_span(mut self, value: crate::datadogV1::model::WidgetLiveSpan) -> Self {
         self.live_span = Some(value);
         self
@@ -56,11 +65,19 @@ impl<'de> Deserialize<'de> for WidgetLegacyLiveSpan {
             where
                 M: MapAccess<'a>,
             {
+                let mut hide_incomplete_cost_data: Option<bool> = None;
                 let mut live_span: Option<crate::datadogV1::model::WidgetLiveSpan> = None;
                 let mut _unparsed = false;
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
+                        "hide_incomplete_cost_data" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            hide_incomplete_cost_data =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "live_span" => {
                             if v.is_null() {
                                 continue;
@@ -86,6 +103,7 @@ impl<'de> Deserialize<'de> for WidgetLegacyLiveSpan {
                 }
 
                 let content = WidgetLegacyLiveSpan {
+                    hide_incomplete_cost_data,
                     live_span,
                     _unparsed,
                 };

src/datadogV1/model/model_widget_new_fixed_span.rs

@@ -14,6 +14,9 @@ pub struct WidgetNewFixedSpan {
     /// Start time in seconds since epoch.
     #[serde(rename = "from")]
     pub from: i64,
+    /// Whether to hide incomplete cost data in the widget.
+    #[serde(rename = "hide_incomplete_cost_data")]
+    pub hide_incomplete_cost_data: Option<bool>,
     /// End time in seconds since epoch.
     #[serde(rename = "to")]
     pub to: i64,
@@ -35,13 +38,19 @@ impl WidgetNewFixedSpan {
     ) -> WidgetNewFixedSpan {
         WidgetNewFixedSpan {
             from,
+            hide_incomplete_cost_data: None,
             to,
             type_,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn hide_incomplete_cost_data(mut self, value: bool) -> Self {
+        self.hide_incomplete_cost_data = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -69,6 +78,7 @@ impl<'de> Deserialize<'de> for WidgetNewFixedSpan {
                 M: MapAccess<'a>,
             {
                 let mut from: Option<i64> = None;
+                let mut hide_incomplete_cost_data: Option<bool> = None;
                 let mut to: Option<i64> = None;
                 let mut type_: Option<crate::datadogV1::model::WidgetNewFixedSpanType> = None;
                 let mut additional_properties: std::collections::BTreeMap<
@@ -82,6 +92,13 @@ impl<'de> Deserialize<'de> for WidgetNewFixedSpan {
                         "from" => {
                             from = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
+                        "hide_incomplete_cost_data" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            hide_incomplete_cost_data =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "to" => {
                             to = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
@@ -109,6 +126,7 @@ impl<'de> Deserialize<'de> for WidgetNewFixedSpan {
 
                 let content = WidgetNewFixedSpan {
                     from,
+                    hide_incomplete_cost_data,
                     to,
                     type_,
                     additional_properties,

src/datadogV1/model/model_widget_new_live_span.rs

@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct WidgetNewLiveSpan {
+    /// Whether to hide incomplete cost data in the widget.
+    #[serde(rename = "hide_incomplete_cost_data")]
+    pub hide_incomplete_cost_data: Option<bool>,
     /// Type "live" denotes a live span in the new format.
     #[serde(rename = "type")]
     pub type_: crate::datadogV1::model::WidgetNewLiveSpanType,
@@ -34,6 +37,7 @@ impl WidgetNewLiveSpan {
         value: i64,
     ) -> WidgetNewLiveSpan {
         WidgetNewLiveSpan {
+            hide_incomplete_cost_data: None,
             type_,
             unit,
             value,
@@ -42,6 +46,11 @@ impl WidgetNewLiveSpan {
         }
     }
 
+    pub fn hide_incomplete_cost_data(mut self, value: bool) -> Self {
+        self.hide_incomplete_cost_data = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -68,6 +77,7 @@ impl<'de> Deserialize<'de> for WidgetNewLiveSpan {
             where
                 M: MapAccess<'a>,
             {
+                let mut hide_incomplete_cost_data: Option<bool> = None;
                 let mut type_: Option<crate::datadogV1::model::WidgetNewLiveSpanType> = None;
                 let mut unit: Option<crate::datadogV1::model::WidgetLiveSpanUnit> = None;
                 let mut value: Option<i64> = None;
@@ -79,6 +89,13 @@ impl<'de> Deserialize<'de> for WidgetNewLiveSpan {
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
+                        "hide_incomplete_cost_data" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            hide_incomplete_cost_data =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "type" => {
                             type_ = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                             if let Some(ref _type_) = type_ {
@@ -118,6 +135,7 @@ impl<'de> Deserialize<'de> for WidgetNewLiveSpan {
                 let value = value.ok_or_else(|| M::Error::missing_field("value"))?;
 
                 let content = WidgetNewLiveSpan {
+                    hide_incomplete_cost_data,
                     type_,
                     unit,
                     value,

tests/scenarios/cassettes/v1/dashboards/Create-a-new-timeseries-widget-with-legacy-live-span-time-format.frozen

@@ -1 +1 @@
-2024-11-15T19:33:02.539Z
+2025-08-26T19:47:58.449Z

tests/scenarios/cassettes/v1/dashboards/Create-a-new-timeseries-widget-with-legacy-live-span-time-format.json

@@ -3,7 +3,7 @@
     {
       "request": {
         "body": {
-          "string": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1731699182 with legacy live span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"}}]}",
+          "string": "{\"layout_type\":\"ordered\",\"reflow_type\":\"auto\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1756237678 with legacy live span time\",\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"hide_incomplete_cost_data\":true,\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"}}]}",
           "encoding": null
         },
         "headers": {
@@ -19,7 +19,7 @@
       },
       "response": {
         "body": {
-          "string": "{\"id\":\"3zr-n9a-dfd\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1731699182 with legacy live span time\",\"description\":null,\"author_handle\":\"[email protected]\",\"author_name\":null,\"layout_type\":\"ordered\",\"url\":\"/dashboard/3zr-n9a-dfd/test-createanewtimeserieswidgetwithlegacylivespantimeformat-1731699182-with-lega\",\"is_read_only\":false,\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":5376392318113781}],\"notify_list\":null,\"created_at\":\"2024-11-15T19:33:02.697929+00:00\",\"modified_at\":\"2024-11-15T19:33:02.697929+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}\n",
+          "string": "{\"id\":\"wek-eci-qnn\",\"title\":\"Test-Create_a_new_timeseries_widget_with_legacy_live_span_time_format-1756237678 with legacy live span time\",\"description\":null,\"author_handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"author_name\":\"CI Account\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/wek-eci-qnn/test-createanewtimeserieswidgetwithlegacylivespantimeformat-1756237678-with-lega\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"legend_columns\":[\"avg\",\"min\",\"max\",\"value\",\"sum\"],\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\",\"metric\":\"@ci.queue_time\"},\"data_source\":\"ci_pipelines\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"ci_level:job\"}}],\"response_format\":\"timeseries\",\"style\":{\"line_type\":\"solid\",\"line_width\":\"normal\",\"palette\":\"dog_classic\"}}],\"show_legend\":true,\"time\":{\"hide_incomplete_cost_data\":true,\"live_span\":\"5m\"},\"title\":\"\",\"type\":\"timeseries\"},\"id\":3088384387119347}],\"notify_list\":null,\"created_at\":\"2025-08-26T19:47:58.616519+00:00\",\"modified_at\":\"2025-08-26T19:47:58.616519+00:00\",\"reflow_type\":\"auto\",\"restricted_roles\":[]}",
           "encoding": null
         },
         "headers": {
@@ -32,7 +32,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Fri, 15 Nov 2024 19:33:02 GMT"
+      "recorded_at": "Tue, 26 Aug 2025 19:47:58 GMT"
     },
     {
       "request": {
@@ -43,11 +43,11 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v1/dashboard/3zr-n9a-dfd"
+        "uri": "https://api.datadoghq.com/api/v1/dashboard/wek-eci-qnn"
       },
       "response": {
         "body": {
-          "string": "{\"deleted_dashboard_id\":\"3zr-n9a-dfd\"}\n",
+          "string": "{\"deleted_dashboard_id\":\"wek-eci-qnn\"}\n",
           "encoding": null
         },
         "headers": {
@@ -60,7 +60,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Fri, 15 Nov 2024 19:33:02 GMT"
+      "recorded_at": "Tue, 26 Aug 2025 19:47:58 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v1/dashboards/Create-a-new-timeseries-widget-with-new-fixed-span-time-format.frozen

@@ -1 +1 @@
-2024-11-15T19:33:02.942Z
+2025-08-26T19:47:58.908Z