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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 591616d97831 · 2026-03-04T22:00:22.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/packages/datadog-api-client-v1/models/BarChartWidgetRequest.ts b/packages/datadog-api-client-v1/models/BarChartWidgetRequest.ts
@@ -55,7 +55,7 @@ export class BarChartWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/ChangeWidgetRequest.ts b/packages/datadog-api-client-v1/models/ChangeWidgetRequest.ts
@@ -68,7 +68,7 @@ export class ChangeWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts b/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts
@@ -52,7 +52,7 @@ export class DistributionWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -64,7 +64,7 @@ export class DistributionWidgetRequest {
    */
   "query"?: DistributionWidgetHistogramRequestQuery;
   /**
-   * Request type for the histogram request.
+   * Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
    */
   "requestType"?: WidgetHistogramRequestType;
   /**
diff --git a/packages/datadog-api-client-v1/models/GeomapWidgetRequest.ts b/packages/datadog-api-client-v1/models/GeomapWidgetRequest.ts
@@ -37,7 +37,7 @@ export class GeomapWidgetRequest {
    */
   "logQuery"?: LogQueryDefinition;
   /**
-   * The widget metrics query.
+   * The widget metrics query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts
@@ -24,7 +24,7 @@ export class HeatMapWidgetDefinition {
    */
   "customLinks"?: Array<WidgetCustomLink>;
   /**
-   * List of widget events.
+   * List of widget events. Deprecated - Use `overlay` request type instead.
    */
   "events"?: Array<WidgetEvent>;
   /**
diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts
@@ -48,7 +48,7 @@ export class HeatMapWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -60,7 +60,7 @@ export class HeatMapWidgetRequest {
    */
   "query"?: FormulaAndFunctionMetricQueryDefinition;
   /**
-   * Request type for the histogram request.
+   * Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
    */
   "requestType"?: WidgetHistogramRequestType;
   /**
diff --git a/packages/datadog-api-client-v1/models/QueryValueWidgetRequest.ts b/packages/datadog-api-client-v1/models/QueryValueWidgetRequest.ts
@@ -58,7 +58,7 @@ export class QueryValueWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * TODO.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/SunburstWidgetRequest.ts b/packages/datadog-api-client-v1/models/SunburstWidgetRequest.ts
@@ -49,7 +49,7 @@ export class SunburstWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/TableWidgetRequest.ts b/packages/datadog-api-client-v1/models/TableWidgetRequest.ts
@@ -79,7 +79,7 @@ export class TableWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/TimeseriesWidgetDefinition.ts b/packages/datadog-api-client-v1/models/TimeseriesWidgetDefinition.ts
@@ -25,7 +25,7 @@ export class TimeseriesWidgetDefinition {
    */
   "customLinks"?: Array<WidgetCustomLink>;
   /**
-   * List of widget events.
+   * List of widget events. Deprecated - Use `overlay` request type instead.
    */
   "events"?: Array<WidgetEvent>;
   /**
diff --git a/packages/datadog-api-client-v1/models/TimeseriesWidgetRequest.ts b/packages/datadog-api-client-v1/models/TimeseriesWidgetRequest.ts
@@ -63,7 +63,7 @@ export class TimeseriesWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/ToplistWidgetRequest.ts b/packages/datadog-api-client-v1/models/ToplistWidgetRequest.ts
@@ -55,7 +55,7 @@ export class ToplistWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/TreeMapWidgetRequest.ts b/packages/datadog-api-client-v1/models/TreeMapWidgetRequest.ts
@@ -18,7 +18,7 @@ export class TreeMapWidgetRequest {
    */
   "formulas"?: Array<WidgetFormula>;
   /**
-   * The widget metrics query.
+   * The widget metrics query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/packages/datadog-api-client-v1/models/WidgetHistogramRequestType.ts b/packages/datadog-api-client-v1/models/WidgetHistogramRequestType.ts
@@ -7,7 +7,7 @@
 import { UnparsedObject } from "../../datadog-api-client-common/util";
 
 /**
- * Request type for the histogram request.
+ * Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
  */
 
 export type WidgetHistogramRequestType = typeof HISTOGRAM | UnparsedObject;
