Mark legacy non-FnF query fields and WidgetEvent as deprecated in dashboard spec and update Distribution docs (#3540)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit aaf315d28c04 · 2026-03-04T22:00:10.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
diff --git a/src/main/java/com/datadog/api/client/v1/model/BarChartWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/BarChartWidgetRequest.java
@@ -317,17 +317,20 @@ public BarChartWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/ChangeWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/ChangeWidgetRequest.java
@@ -389,17 +389,20 @@ public ChangeWidgetRequest q(String q) {
   }
 
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/DistributionWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/DistributionWidgetRequest.java
@@ -282,17 +282,20 @@ public DistributionWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
@@ -359,7 +362,8 @@ public DistributionWidgetRequest requestType(WidgetHistogramRequestType requestT
   }
 
   /**
-   * Request type for the histogram request.
+   * Request type for distribution of point values for distribution metrics. Query space aggregator
+   * must be <code>histogram:&lt;metric name&gt;</code> for points distributions.
    *
    * @return requestType
    */
diff --git a/src/main/java/com/datadog/api/client/v1/model/GeomapWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/GeomapWidgetRequest.java
@@ -205,17 +205,21 @@ public GeomapWidgetRequest q(String q) {
   }
 
   /**
-   * The widget metrics query.
+   * The widget metrics query. Deprecated - Use <code>queries</code> and <code>formulas</code>
+   * instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/HeatMapWidgetDefinition.java b/src/main/java/com/datadog/api/client/v1/model/HeatMapWidgetDefinition.java
@@ -144,17 +144,20 @@ public HeatMapWidgetDefinition addEventsItem(WidgetEvent eventsItem) {
   }
 
   /**
-   * List of widget events.
+   * List of widget events. Deprecated - Use <code>overlay</code> request type instead.
    *
    * @return events
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_EVENTS)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public List<WidgetEvent> getEvents() {
     return events;
   }
 
+  @Deprecated
   public void setEvents(List<WidgetEvent> events) {
     this.events = events;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/HeatMapWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/HeatMapWidgetRequest.java
@@ -256,17 +256,20 @@ public HeatMapWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
@@ -333,7 +336,8 @@ public HeatMapWidgetRequest requestType(WidgetHistogramRequestType requestType)
   }
 
   /**
-   * Request type for the histogram request.
+   * Request type for distribution of point values for distribution metrics. Query space aggregator
+   * must be <code>histogram:&lt;metric name&gt;</code> for points distributions.
    *
    * @return requestType
    */
diff --git a/src/main/java/com/datadog/api/client/v1/model/QueryValueWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/QueryValueWidgetRequest.java
@@ -338,17 +338,20 @@ public QueryValueWidgetRequest q(String q) {
   }
 
   /**
-   * TODO.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/SunburstWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/SunburstWidgetRequest.java
@@ -274,17 +274,20 @@ public SunburstWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/TableWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/TableWidgetRequest.java
@@ -459,17 +459,20 @@ public TableWidgetRequest q(String q) {
   }
 
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/TimeseriesWidgetDefinition.java b/src/main/java/com/datadog/api/client/v1/model/TimeseriesWidgetDefinition.java
@@ -153,17 +153,20 @@ public TimeseriesWidgetDefinition addEventsItem(WidgetEvent eventsItem) {
   }
 
   /**
-   * List of widget events.
+   * List of widget events. Deprecated - Use <code>overlay</code> request type instead.
    *
    * @return events
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_EVENTS)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public List<WidgetEvent> getEvents() {
     return events;
   }
 
+  @Deprecated
   public void setEvents(List<WidgetEvent> events) {
     this.events = events;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/TimeseriesWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/TimeseriesWidgetRequest.java
@@ -365,17 +365,20 @@ public TimeseriesWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/ToplistWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/ToplistWidgetRequest.java
@@ -316,17 +316,20 @@ public ToplistWidgetRequest q(String q) {
   }
 
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/TreeMapWidgetRequest.java b/src/main/java/com/datadog/api/client/v1/model/TreeMapWidgetRequest.java
@@ -80,17 +80,21 @@ public TreeMapWidgetRequest q(String q) {
   }
 
   /**
-   * The widget metrics query.
+   * The widget metrics query. Deprecated - Use <code>queries</code> and <code>formulas</code>
+   * instead.
    *
    * @return q
+   * @deprecated
    */
+  @Deprecated
   @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_Q)
   @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
   public String getQ() {
     return q;
   }
 
+  @Deprecated
   public void setQ(String q) {
     this.q = q;
   }
diff --git a/src/main/java/com/datadog/api/client/v1/model/WidgetEvent.java b/src/main/java/com/datadog/api/client/v1/model/WidgetEvent.java
@@ -23,7 +23,10 @@
  * <p>See the dedicated <a
  * href="https://docs.datadoghq.com/dashboards/graphing_json/widget_json/#events-schema">Events JSON
  * schema documentation</a> to learn how to build the <code>&lt;EVENTS_SCHEMA&gt;</code>.
+ *
+ * @deprecated
  */
+@Deprecated
 @JsonPropertyOrder({WidgetEvent.JSON_PROPERTY_Q, WidgetEvent.JSON_PROPERTY_TAGS_EXECUTION})
 @jakarta.annotation.Generated(
     value = "https://github.com/DataDog/datadog-api-client-java/blob/master/.generator")
diff --git a/src/main/java/com/datadog/api/client/v1/model/WidgetHistogramRequestType.java b/src/main/java/com/datadog/api/client/v1/model/WidgetHistogramRequestType.java
@@ -18,7 +18,10 @@
 import java.util.HashSet;
 import java.util.Set;
 
-/** Request type for the histogram request. */
+/**
+ * Request type for distribution of point values for distribution metrics. Query space aggregator
+ * must be <code>histogram:&lt;metric name&gt;</code> for points distributions.
+ */
 @JsonSerialize(using = WidgetHistogramRequestType.WidgetHistogramRequestTypeSerializer.class)
 public class WidgetHistogramRequestType extends ModelEnum<String> {
 

Original file line number	Diff line number	Diff line change
`@@ -317,17 +317,20 @@ public BarChartWidgetRequest q(String q) {`
`317`	`317`	`}`
`318`	`318`
`319`	`319`	`/**`
`320`		`- * Widget query.`
	`320`	`+ * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`321`	`321`	`*`
`322`	`322`	`* @return q`
	`323`	`+ * @deprecated`
`323`	`324`	`*/`
	`325`	`+ @Deprecated`
`324`	`326`	`@jakarta.annotation.Nullable`
`325`	`327`	`@JsonProperty(JSON_PROPERTY_Q)`
`326`	`328`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`327`	`329`	`public String getQ() {`
`328`	`330`	`return q;`
`329`	`331`	`}`
`330`	`332`
	`333`	`+ @Deprecated`
`331`	`334`	`public void setQ(String q) {`
`332`	`335`	`this.q = q;`
`333`	`336`	`}`
Original file line number	Diff line number	Diff line change
`@@ -389,17 +389,20 @@ public ChangeWidgetRequest q(String q) {`
`389`	`389`	`}`
`390`	`390`
`391`	`391`	`/**`
`392`		`- * Query definition.`
	`392`	`+ * Query definition. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`393`	`393`	`*`
`394`	`394`	`* @return q`
	`395`	`+ * @deprecated`
`395`	`396`	`*/`
	`397`	`+ @Deprecated`
`396`	`398`	`@jakarta.annotation.Nullable`
`397`	`399`	`@JsonProperty(JSON_PROPERTY_Q)`
`398`	`400`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`399`	`401`	`public String getQ() {`
`400`	`402`	`return q;`
`401`	`403`	`}`
`402`	`404`
	`405`	`+ @Deprecated`
`403`	`406`	`public void setQ(String q) {`
`404`	`407`	`this.q = q;`
`405`	`408`	`}`
Original file line number	Diff line number	Diff line change
`@@ -282,17 +282,20 @@ public DistributionWidgetRequest q(String q) {`
`282`	`282`	`}`
`283`	`283`
`284`	`284`	`/**`
`285`		`- * Widget query.`
	`285`	`+ * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`286`	`286`	`*`
`287`	`287`	`* @return q`
	`288`	`+ * @deprecated`
`288`	`289`	`*/`
	`290`	`+ @Deprecated`
`289`	`291`	`@jakarta.annotation.Nullable`
`290`	`292`	`@JsonProperty(JSON_PROPERTY_Q)`
`291`	`293`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`292`	`294`	`public String getQ() {`
`293`	`295`	`return q;`
`294`	`296`	`}`
`295`	`297`
	`298`	`+ @Deprecated`
`296`	`299`	`public void setQ(String q) {`
`297`	`300`	`this.q = q;`
`298`	`301`	`}`
`@@ -359,7 +362,8 @@ public DistributionWidgetRequest requestType(WidgetHistogramRequestType requestT`
`359`	`362`	`}`
`360`	`363`
`361`	`364`	`/**`
`362`		`- * Request type for the histogram request.`
	`365`	`+ * Request type for distribution of point values for distribution metrics. Query space aggregator`
	`366`	`+ * must be <code>histogram:<metric name></code> for points distributions.`
`363`	`367`	`*`
`364`	`368`	`* @return requestType`
`365`	`369`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -205,17 +205,21 @@ public GeomapWidgetRequest q(String q) {`
`205`	`205`	`}`
`206`	`206`
`207`	`207`	`/**`
`208`		`- * The widget metrics query.`
	`208`	`+ * The widget metrics query. Deprecated - Use <code>queries</code> and <code>formulas</code>`
	`209`	`+ * instead.`
`209`	`210`	`*`
`210`	`211`	`* @return q`
	`212`	`+ * @deprecated`
`211`	`213`	`*/`
	`214`	`+ @Deprecated`
`212`	`215`	`@jakarta.annotation.Nullable`
`213`	`216`	`@JsonProperty(JSON_PROPERTY_Q)`
`214`	`217`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`215`	`218`	`public String getQ() {`
`216`	`219`	`return q;`
`217`	`220`	`}`
`218`	`221`
	`222`	`+ @Deprecated`
`219`	`223`	`public void setQ(String q) {`
`220`	`224`	`this.q = q;`
`221`	`225`	`}`
Original file line number	Diff line number	Diff line change
`@@ -144,17 +144,20 @@ public HeatMapWidgetDefinition addEventsItem(WidgetEvent eventsItem) {`
`144`	`144`	`}`
`145`	`145`
`146`	`146`	`/**`
`147`		`- * List of widget events.`
	`147`	`+ * List of widget events. Deprecated - Use <code>overlay</code> request type instead.`
`148`	`148`	`*`
`149`	`149`	`* @return events`
	`150`	`+ * @deprecated`
`150`	`151`	`*/`
	`152`	`+ @Deprecated`
`151`	`153`	`@jakarta.annotation.Nullable`
`152`	`154`	`@JsonProperty(JSON_PROPERTY_EVENTS)`
`153`	`155`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`154`	`156`	`public List<WidgetEvent> getEvents() {`
`155`	`157`	`return events;`
`156`	`158`	`}`
`157`	`159`
	`160`	`+ @Deprecated`
`158`	`161`	`public void setEvents(List<WidgetEvent> events) {`
`159`	`162`	`this.events = events;`
`160`	`163`	`}`
Original file line number	Diff line number	Diff line change
`@@ -256,17 +256,20 @@ public HeatMapWidgetRequest q(String q) {`
`256`	`256`	`}`
`257`	`257`
`258`	`258`	`/**`
`259`		`- * Widget query.`
	`259`	`+ * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`260`	`260`	`*`
`261`	`261`	`* @return q`
	`262`	`+ * @deprecated`
`262`	`263`	`*/`
	`264`	`+ @Deprecated`
`263`	`265`	`@jakarta.annotation.Nullable`
`264`	`266`	`@JsonProperty(JSON_PROPERTY_Q)`
`265`	`267`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`266`	`268`	`public String getQ() {`
`267`	`269`	`return q;`
`268`	`270`	`}`
`269`	`271`
	`272`	`+ @Deprecated`
`270`	`273`	`public void setQ(String q) {`
`271`	`274`	`this.q = q;`
`272`	`275`	`}`
`@@ -333,7 +336,8 @@ public HeatMapWidgetRequest requestType(WidgetHistogramRequestType requestType)`
`333`	`336`	`}`
`334`	`337`
`335`	`338`	`/**`
`336`		`- * Request type for the histogram request.`
	`339`	`+ * Request type for distribution of point values for distribution metrics. Query space aggregator`
	`340`	`+ * must be <code>histogram:<metric name></code> for points distributions.`
`337`	`341`	`*`
`338`	`342`	`* @return requestType`
`339`	`343`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -338,17 +338,20 @@ public QueryValueWidgetRequest q(String q) {`
`338`	`338`	`}`
`339`	`339`
`340`	`340`	`/**`
`341`		`- * TODO.`
	`341`	`+ * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`342`	`342`	`*`
`343`	`343`	`* @return q`
	`344`	`+ * @deprecated`
`344`	`345`	`*/`
	`346`	`+ @Deprecated`
`345`	`347`	`@jakarta.annotation.Nullable`
`346`	`348`	`@JsonProperty(JSON_PROPERTY_Q)`
`347`	`349`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`348`	`350`	`public String getQ() {`
`349`	`351`	`return q;`
`350`	`352`	`}`
`351`	`353`
	`354`	`+ @Deprecated`
`352`	`355`	`public void setQ(String q) {`
`353`	`356`	`this.q = q;`
`354`	`357`	`}`
Original file line number	Diff line number	Diff line change
`@@ -274,17 +274,20 @@ public SunburstWidgetRequest q(String q) {`
`274`	`274`	`}`
`275`	`275`
`276`	`276`	`/**`
`277`		`- * Widget query.`
	`277`	`+ * Widget query. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`278`	`278`	`*`
`279`	`279`	`* @return q`
	`280`	`+ * @deprecated`
`280`	`281`	`*/`
	`282`	`+ @Deprecated`
`281`	`283`	`@jakarta.annotation.Nullable`
`282`	`284`	`@JsonProperty(JSON_PROPERTY_Q)`
`283`	`285`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`284`	`286`	`public String getQ() {`
`285`	`287`	`return q;`
`286`	`288`	`}`
`287`	`289`
	`290`	`+ @Deprecated`
`288`	`291`	`public void setQ(String q) {`
`289`	`292`	`this.q = q;`
`290`	`293`	`}`
Original file line number	Diff line number	Diff line change
`@@ -459,17 +459,20 @@ public TableWidgetRequest q(String q) {`
`459`	`459`	`}`
`460`	`460`
`461`	`461`	`/**`
`462`		`- * Query definition.`
	`462`	`+ * Query definition. Deprecated - Use <code>queries</code> and <code>formulas</code> instead.`
`463`	`463`	`*`
`464`	`464`	`* @return q`
	`465`	`+ * @deprecated`
`465`	`466`	`*/`
	`467`	`+ @Deprecated`
`466`	`468`	`@jakarta.annotation.Nullable`
`467`	`469`	`@JsonProperty(JSON_PROPERTY_Q)`
`468`	`470`	`@JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)`
`469`	`471`	`public String getQ() {`
`470`	`472`	`return q;`
`471`	`473`	`}`
`472`	`474`
	`475`	`+ @Deprecated`
`473`	`476`	`public void setQ(String q) {`
`474`	`477`	`this.q = q;`
`475`	`478`	`}`