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

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit aff103b75dec · 2026-03-04T21:59:57.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/services/dashboards/src/v1/models/BarChartWidgetRequest.ts b/services/dashboards/src/v1/models/BarChartWidgetRequest.ts
@@ -50,7 +50,7 @@ export class BarChartWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/ChangeWidgetRequest.ts b/services/dashboards/src/v1/models/ChangeWidgetRequest.ts
@@ -63,7 +63,7 @@ export class ChangeWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/DistributionWidgetRequest.ts b/services/dashboards/src/v1/models/DistributionWidgetRequest.ts
@@ -47,7 +47,7 @@ export class DistributionWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -59,7 +59,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/services/dashboards/src/v1/models/GeomapWidgetRequest.ts b/services/dashboards/src/v1/models/GeomapWidgetRequest.ts
@@ -32,7 +32,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/services/dashboards/src/v1/models/HeatMapWidgetDefinition.ts b/services/dashboards/src/v1/models/HeatMapWidgetDefinition.ts
@@ -19,7 +19,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/services/dashboards/src/v1/models/HeatMapWidgetRequest.ts b/services/dashboards/src/v1/models/HeatMapWidgetRequest.ts
@@ -43,7 +43,7 @@ export class HeatMapWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -55,7 +55,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/services/dashboards/src/v1/models/QueryValueWidgetRequest.ts b/services/dashboards/src/v1/models/QueryValueWidgetRequest.ts
@@ -53,7 +53,7 @@ export class QueryValueWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * TODO.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/SunburstWidgetRequest.ts b/services/dashboards/src/v1/models/SunburstWidgetRequest.ts
@@ -44,7 +44,7 @@ export class SunburstWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/TableWidgetRequest.ts b/services/dashboards/src/v1/models/TableWidgetRequest.ts
@@ -74,7 +74,7 @@ export class TableWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Query definition.
+   * Query definition. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/TimeseriesWidgetDefinition.ts b/services/dashboards/src/v1/models/TimeseriesWidgetDefinition.ts
@@ -20,7 +20,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/services/dashboards/src/v1/models/TimeseriesWidgetRequest.ts b/services/dashboards/src/v1/models/TimeseriesWidgetRequest.ts
@@ -58,7 +58,7 @@ export class TimeseriesWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/ToplistWidgetRequest.ts b/services/dashboards/src/v1/models/ToplistWidgetRequest.ts
@@ -50,7 +50,7 @@ export class ToplistWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/dashboards/src/v1/models/TreeMapWidgetRequest.ts b/services/dashboards/src/v1/models/TreeMapWidgetRequest.ts
@@ -13,7 +13,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/services/dashboards/src/v1/models/WidgetHistogramRequestType.ts b/services/dashboards/src/v1/models/WidgetHistogramRequestType.ts
@@ -1,7 +1,7 @@
 import { UnparsedObject } from "@datadog/datadog-api-client";
 
 /**
- * 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;
 export const HISTOGRAM = "histogram";
diff --git a/services/notebooks/src/v1/models/DistributionWidgetRequest.ts b/services/notebooks/src/v1/models/DistributionWidgetRequest.ts
@@ -47,7 +47,7 @@ export class DistributionWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -59,7 +59,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/services/notebooks/src/v1/models/HeatMapWidgetDefinition.ts b/services/notebooks/src/v1/models/HeatMapWidgetDefinition.ts
@@ -19,7 +19,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/services/notebooks/src/v1/models/HeatMapWidgetRequest.ts b/services/notebooks/src/v1/models/HeatMapWidgetRequest.ts
@@ -43,7 +43,7 @@ export class HeatMapWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
@@ -55,7 +55,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/services/notebooks/src/v1/models/TimeseriesWidgetDefinition.ts b/services/notebooks/src/v1/models/TimeseriesWidgetDefinition.ts
@@ -20,7 +20,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/services/notebooks/src/v1/models/TimeseriesWidgetRequest.ts b/services/notebooks/src/v1/models/TimeseriesWidgetRequest.ts
@@ -58,7 +58,7 @@ export class TimeseriesWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/notebooks/src/v1/models/ToplistWidgetRequest.ts b/services/notebooks/src/v1/models/ToplistWidgetRequest.ts
@@ -50,7 +50,7 @@ export class ToplistWidgetRequest {
    */
   "profileMetricsQuery"?: LogQueryDefinition;
   /**
-   * Widget query.
+   * Widget query. Deprecated - Use `queries` and `formulas` instead.
    */
   "q"?: string;
   /**
diff --git a/services/notebooks/src/v1/models/WidgetHistogramRequestType.ts b/services/notebooks/src/v1/models/WidgetHistogramRequestType.ts
@@ -1,7 +1,7 @@
 import { UnparsedObject } from "@datadog/datadog-api-client";
 
 /**
- * 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;
 export const HISTOGRAM = "histogram";
