From c733329a269d3ceb62cae505a48ab9a68e7c4699 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Fri, 19 Dec 2025 10:23:10 +0000 Subject: [PATCH] Regenerate client from commit ccaecb4 of spec repo --- .generator/schemas/v1/openapi.yaml | 69 +++++++++-- .../frozen.json | 1 + .../recording.har | 110 ++++++++++++++++++ .../frozen.json | 1 + .../recording.har | 110 ++++++++++++++++++ .../frozen.json | 1 + .../recording.har | 110 ++++++++++++++++++ .../dashboards/CreateDashboard_1093147852.ts | 80 +++++++++++++ .../dashboards/CreateDashboard_1617893815.ts | 73 ++++++++++++ .../dashboards/CreateDashboard_2823363212.ts | 69 +++++++++++ features/v1/dashboards.feature | 32 +++++ packages/datadog-api-client-v1/index.ts | 3 +- .../models/DistributionWidgetRequest.ts | 33 +++++- .../models/DistributionWidgetXAxis.ts | 9 ++ .../models/HeatMapWidgetDefinition.ts | 18 +++ .../models/HeatMapWidgetRequest.ts | 18 +++ .../models/HeatMapWidgetXAxis.ts | 53 +++++++++ .../models/ObjectSerializer.ts | 4 +- ...tType.ts => WidgetHistogramRequestType.ts} | 4 +- .../models/WidgetMarker.ts | 3 +- 20 files changed, 781 insertions(+), 20 deletions(-) create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/frozen.json create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/recording.har create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/frozen.json create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/recording.har create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/frozen.json create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/recording.har create mode 100644 examples/v1/dashboards/CreateDashboard_1093147852.ts create mode 100644 examples/v1/dashboards/CreateDashboard_1617893815.ts create mode 100644 examples/v1/dashboards/CreateDashboard_2823363212.ts create mode 100644 packages/datadog-api-client-v1/models/HeatMapWidgetXAxis.ts rename packages/datadog-api-client-v1/models/{DistributionWidgetHistogramRequestType.ts => WidgetHistogramRequestType.ts} (81%) diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index d9bb88a10f27..7d3eaefcd084 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -1741,6 +1741,9 @@ components: type: string markers: description: List of markers. + example: + - display_type: percentile + value: '90' items: $ref: '#/components/schemas/WidgetMarker' type: array @@ -1799,14 +1802,6 @@ components: - $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' - $ref: '#/components/schemas/FormulaAndFunctionEventQueryDefinition' - $ref: '#/components/schemas/FormulaAndFunctionApmResourceStatsQueryDefinition' - DistributionWidgetHistogramRequestType: - description: Request type for the histogram request. - enum: - - histogram - example: histogram - type: string - x-enum-varnames: - - HISTOGRAM DistributionWidgetRequest: description: Updated distribution widget. properties: @@ -1816,6 +1811,11 @@ components: $ref: '#/components/schemas/ApmStatsQueryDefinition' event_query: $ref: '#/components/schemas/LogQueryDefinition' + formulas: + description: List of formulas that operate on queries. + items: + $ref: '#/components/schemas/WidgetFormula' + type: array log_query: $ref: '#/components/schemas/LogQueryDefinition' network_query: @@ -1827,10 +1827,17 @@ components: q: description: Widget query. type: string + queries: + description: List of queries that can be returned directly or used in formulas. + items: + $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' + type: array query: $ref: '#/components/schemas/DistributionWidgetHistogramRequestQuery' request_type: - $ref: '#/components/schemas/DistributionWidgetHistogramRequestType' + $ref: '#/components/schemas/WidgetHistogramRequestType' + response_format: + $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' rum_query: $ref: '#/components/schemas/LogQueryDefinition' security_query: @@ -1854,6 +1861,11 @@ components: description: Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. type: string + num_buckets: + description: Number of value buckets to target, also known as the resolution + of the value bins. + format: int64 + type: integer scale: default: linear description: Specifies the scale type. Possible values are `linear`. @@ -3752,6 +3764,14 @@ components: type: array legend_size: $ref: '#/components/schemas/WidgetLegendSize' + markers: + description: List of markers. + example: + - display_type: percentile + value: '90' + items: + $ref: '#/components/schemas/WidgetMarker' + type: array requests: description: List of widget types. example: @@ -3776,6 +3796,8 @@ components: type: string type: $ref: '#/components/schemas/HeatMapWidgetDefinitionType' + xaxis: + $ref: '#/components/schemas/HeatMapWidgetXAxis' yaxis: $ref: '#/components/schemas/WidgetAxis' required: @@ -3819,6 +3841,10 @@ components: items: $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition' type: array + query: + $ref: '#/components/schemas/FormulaAndFunctionMetricQueryDefinition' + request_type: + $ref: '#/components/schemas/WidgetHistogramRequestType' response_format: $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' rum_query: @@ -3828,6 +3854,16 @@ components: style: $ref: '#/components/schemas/WidgetStyle' type: object + HeatMapWidgetXAxis: + description: X Axis controls for the heat map widget. + properties: + num_buckets: + description: Number of time buckets to target, also known as the resolution + of the time bins. This is only applicable for distribution of points (group + distributions use the roll-up modifier). + format: int64 + type: integer + type: object Host: description: Object representing a host. properties: @@ -25041,6 +25077,14 @@ components: x-enum-varnames: - CHECK - CLUSTER + WidgetHistogramRequestType: + description: Request type for the histogram request. + enum: + - histogram + example: histogram + type: string + x-enum-varnames: + - HISTOGRAM WidgetHorizontalAlign: description: Horizontal alignment. enum: @@ -25245,7 +25289,7 @@ components: display_type: description: "Combination of:\n - A severity error, warning, ok, or info\n \ - A line type: dashed, solid, or bold\nIn this case of a Distribution - widget, this can be set to be `x_axis_percentile`." + widget, this can be set to be `percentile`." example: error dashed type: string label: @@ -25256,8 +25300,11 @@ components: description: Timestamp for the widget. type: string value: - description: Value to apply. Can be a single value y = 15 or a range of + description: 'Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. + + For Distribution widgets with `display_type` set to `percentile`, this + should be a numeric percentile value (for example, "90" for P90).' example: y = 15 type: string required: diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/frozen.json new file mode 100644 index 000000000000..6b8f2ed40232 --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/frozen.json @@ -0,0 +1 @@ +"2025-12-04T23:08:04.708Z" diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/recording.har new file mode 100644 index 000000000000..86ab16eb9732 --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-distribution-widget-with-markers-and-num_buckets_3407795848/recording.har @@ -0,0 +1,110 @@ +{ + "log": { + "_recordingName": "Dashboards/Create a new dashboard with distribution widget with markers and num_buckets", + "creator": { + "comment": "persister:fs", + "name": "Polly.JS", + "version": "6.0.5" + }, + "entries": [ + { + "_id": "1965461eb336d2a7fcff22eeba84a215", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 738, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + }, + { + "_fromType": "array", + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 559, + "httpVersion": "HTTP/1.1", + "method": "POST", + "postData": { + "mimeType": "application/json", + "params": [], + "text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_distribution_widget_with_markers_and_num_buckets-1764889684\",\"widgets\":[{\"definition\":{\"markers\":[{\"display_type\":\"percentile\",\"value\":\"50\"},{\"display_type\":\"percentile\",\"value\":\"99\"},{\"display_type\":\"percentile\",\"value\":\"90\"}],\"requests\":[{\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"distribution\",\"xaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"num_buckets\":55,\"scale\":\"linear\"},\"yaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"scale\":\"linear\"}},\"layout\":{\"height\":4,\"width\":4,\"x\":0,\"y\":0}}]}" + }, + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard" + }, + "response": { + "bodySize": 1143, + "content": { + "mimeType": "application/json", + "size": 1143, + "text": "{\"id\":\"ved-atm-2g5\",\"title\":\"Test-Create_a_new_dashboard_with_distribution_widget_with_markers_and_num_buckets-1764889684\",\"description\":null,\"author_handle\":\"shishi.liu@datadoghq.com\",\"author_name\":\"Shishi Liu\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/ved-atm-2g5/test-createanewdashboardwithdistributionwidgetwithmarkersandnumbuckets-176488968\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"markers\":[{\"display_type\":\"percentile\",\"value\":\"50\"},{\"display_type\":\"percentile\",\"value\":\"99\"},{\"display_type\":\"percentile\",\"value\":\"90\"}],\"requests\":[{\"queries\":[{\"aggregator\":\"avg\",\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*} by {service}\"}],\"response_format\":\"scalar\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"distribution\",\"xaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"num_buckets\":55,\"scale\":\"linear\"},\"yaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"scale\":\"linear\"}},\"layout\":{\"height\":4,\"width\":4,\"x\":0,\"y\":0},\"id\":984443192078703}],\"notify_list\":null,\"created_at\":\"2025-12-04T23:08:05.111437+00:00\",\"modified_at\":\"2025-12-04T23:08:05.111437+00:00\",\"restricted_roles\":[]}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 381, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-04T23:08:04.722Z", + "time": 504 + }, + { + "_id": "05322de5f1c06078f3806223fd28da2c", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 0, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + } + ], + "headersSize": 520, + "httpVersion": "HTTP/1.1", + "method": "DELETE", + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard/ved-atm-2g5" + }, + "response": { + "bodySize": 38, + "content": { + "mimeType": "application/json", + "size": 38, + "text": "{\"deleted_dashboard_id\":\"ved-atm-2g5\"}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 379, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-04T23:08:05.249Z", + "time": 675 + } + ], + "pages": [], + "version": "1.2" + } +} diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/frozen.json new file mode 100644 index 000000000000..afd68020112f --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/frozen.json @@ -0,0 +1 @@ +"2025-12-15T17:03:52.164Z" diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/recording.har new file mode 100644 index 000000000000..61d886ae8b9c --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-distribution-widget_518041603/recording.har @@ -0,0 +1,110 @@ +{ + "log": { + "_recordingName": "Dashboards/Create a new dashboard with formula and function distribution widget", + "creator": { + "comment": "persister:fs", + "name": "Polly.JS", + "version": "6.0.5" + }, + "entries": [ + { + "_id": "db029f7077dde3aa94094d0b02ae83f1", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 607, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + }, + { + "_fromType": "array", + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 559, + "httpVersion": "HTTP/1.1", + "method": "POST", + "postData": { + "mimeType": "application/json", + "params": [], + "text": "{\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_formula_and_function_distribution_widget-1765818232\",\"widgets\":[{\"definition\":{\"requests\":[{\"queries\":[{\"compute\":{\"aggregation\":\"avg\",\"metric\":\"@duration\"},\"data_source\":\"logs\",\"group_by\":[{\"facet\":\"service\",\"limit\":1000,\"sort\":{\"aggregation\":\"count\",\"order\":\"desc\"}}],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"\"},\"storage\":\"hot\"}],\"response_format\":\"scalar\"}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"distribution\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}" + }, + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard" + }, + "response": { + "bodySize": 963, + "content": { + "mimeType": "application/json", + "size": 963, + "text": "{\"id\":\"ii3-z6t-p8x\",\"title\":\"Test-Create_a_new_dashboard_with_formula_and_function_distribution_widget-1765818232\",\"description\":null,\"author_handle\":\"shishi.liu@datadoghq.com\",\"author_name\":\"Shishi Liu\",\"layout_type\":\"free\",\"url\":\"/dashboard/ii3-z6t-p8x/test-createanewdashboardwithformulaandfunctiondistributionwidget-1765818232\",\"template_variables\":[],\"widgets\":[{\"definition\":{\"requests\":[{\"queries\":[{\"compute\":{\"aggregation\":\"avg\",\"metric\":\"@duration\"},\"data_source\":\"logs\",\"group_by\":[{\"facet\":\"service\",\"limit\":1000,\"sort\":{\"aggregation\":\"count\",\"order\":\"desc\"}}],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"\"},\"storage\":\"hot\"}],\"response_format\":\"scalar\"}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"distribution\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0},\"id\":1822470106302094}],\"notify_list\":[],\"created_at\":\"2025-12-15T17:03:52.607823+00:00\",\"modified_at\":\"2025-12-15T17:03:52.607823+00:00\",\"restricted_roles\":[]}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 379, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-15T17:03:52.176Z", + "time": 585 + }, + { + "_id": "2a9d55c736a90318e46feebe3c54cd02", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 0, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + } + ], + "headersSize": 520, + "httpVersion": "HTTP/1.1", + "method": "DELETE", + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard/ii3-z6t-p8x" + }, + "response": { + "bodySize": 38, + "content": { + "mimeType": "application/json", + "size": 38, + "text": "{\"deleted_dashboard_id\":\"ii3-z6t-p8x\"}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 378, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-15T17:03:52.785Z", + "time": 670 + } + ], + "pages": [], + "version": "1.2" + } +} diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/frozen.json new file mode 100644 index 000000000000..3698f5587678 --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/frozen.json @@ -0,0 +1 @@ +"2025-12-15T17:39:03.378Z" diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/recording.har new file mode 100644 index 000000000000..39da74d5f128 --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-heatmap-widget-with-markers-and-num_buckets_3970320818/recording.har @@ -0,0 +1,110 @@ +{ + "log": { + "_recordingName": "Dashboards/Create a new dashboard with heatmap widget with markers and num_buckets", + "creator": { + "comment": "persister:fs", + "name": "Polly.JS", + "version": "6.0.5" + }, + "entries": [ + { + "_id": "5805834db0c21af94aea89ac0853ff0c", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 598, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + }, + { + "_fromType": "array", + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 559, + "httpVersion": "HTTP/1.1", + "method": "POST", + "postData": { + "mimeType": "application/json", + "params": [], + "text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_heatmap_widget_with_markers_and_num_buckets-1765820343\",\"widgets\":[{\"definition\":{\"markers\":[{\"display_type\":\"percentile\",\"value\":\"50\"},{\"display_type\":\"percentile\",\"value\":\"99\"}],\"requests\":[{\"query\":{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"histogram:trace.servlet.request{*}\"},\"request_type\":\"histogram\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"heatmap\",\"xaxis\":{\"num_buckets\":75},\"yaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"scale\":\"linear\"}},\"layout\":{\"height\":4,\"width\":4,\"x\":0,\"y\":0}}]}" + }, + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard" + }, + "response": { + "bodySize": 1000, + "content": { + "mimeType": "application/json", + "size": 1000, + "text": "{\"id\":\"r3p-kik-ven\",\"title\":\"Test-Create_a_new_dashboard_with_heatmap_widget_with_markers_and_num_buckets-1765820343\",\"description\":null,\"author_handle\":\"shishi.liu@datadoghq.com\",\"author_name\":\"Shishi Liu\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/r3p-kik-ven/test-createanewdashboardwithheatmapwidgetwithmarkersandnumbuckets-1765820343\",\"template_variables\":null,\"widgets\":[{\"definition\":{\"markers\":[{\"display_type\":\"percentile\",\"value\":\"50\"},{\"display_type\":\"percentile\",\"value\":\"99\"}],\"requests\":[{\"query\":{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"histogram:trace.servlet.request{*}\"},\"request_type\":\"histogram\"}],\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"heatmap\",\"xaxis\":{\"num_buckets\":75},\"yaxis\":{\"include_zero\":true,\"max\":\"auto\",\"min\":\"auto\",\"scale\":\"linear\"}},\"layout\":{\"height\":4,\"width\":4,\"x\":0,\"y\":0},\"id\":4627813855695599}],\"notify_list\":null,\"created_at\":\"2025-12-15T17:39:03.852775+00:00\",\"modified_at\":\"2025-12-15T17:39:03.852775+00:00\",\"restricted_roles\":[]}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 381, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-15T17:39:03.391Z", + "time": 534 + }, + { + "_id": "594d80bce9fd8b3d7938ac4f944e6b93", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 0, + "cookies": [], + "headers": [ + { + "_fromType": "array", + "name": "accept", + "value": "application/json" + } + ], + "headersSize": 520, + "httpVersion": "HTTP/1.1", + "method": "DELETE", + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard/r3p-kik-ven" + }, + "response": { + "bodySize": 38, + "content": { + "mimeType": "application/json", + "size": 38, + "text": "{\"deleted_dashboard_id\":\"r3p-kik-ven\"}" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 379, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2025-12-15T17:39:03.949Z", + "time": 657 + } + ], + "pages": [], + "version": "1.2" + } +} diff --git a/examples/v1/dashboards/CreateDashboard_1093147852.ts b/examples/v1/dashboards/CreateDashboard_1093147852.ts new file mode 100644 index 000000000000..278025a41e89 --- /dev/null +++ b/examples/v1/dashboards/CreateDashboard_1093147852.ts @@ -0,0 +1,80 @@ +/** + * Create a new dashboard with distribution widget with markers and num_buckets + */ + +import { client, v1 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v1.DashboardsApi(configuration); + +const params: v1.DashboardsApiCreateDashboardRequest = { + body: { + title: "Example-Dashboard", + widgets: [ + { + definition: { + title: "", + titleSize: "16", + titleAlign: "left", + type: "distribution", + xaxis: { + scale: "linear", + min: "auto", + max: "auto", + includeZero: true, + numBuckets: 55, + }, + yaxis: { + scale: "linear", + min: "auto", + max: "auto", + includeZero: true, + }, + markers: [ + { + displayType: "percentile", + value: "50", + }, + { + displayType: "percentile", + value: "99", + }, + { + displayType: "percentile", + value: "90", + }, + ], + requests: [ + { + responseFormat: "scalar", + queries: [ + { + dataSource: "metrics", + name: "query1", + query: "avg:system.cpu.user{*} by {service}", + aggregator: "avg", + }, + ], + }, + ], + }, + layout: { + x: 0, + y: 0, + width: 4, + height: 4, + }, + }, + ], + layoutType: "ordered", + }, +}; + +apiInstance + .createDashboard(params) + .then((data: v1.Dashboard) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }) + .catch((error: any) => console.error(error)); diff --git a/examples/v1/dashboards/CreateDashboard_1617893815.ts b/examples/v1/dashboards/CreateDashboard_1617893815.ts new file mode 100644 index 000000000000..e35f0b9a3e4d --- /dev/null +++ b/examples/v1/dashboards/CreateDashboard_1617893815.ts @@ -0,0 +1,73 @@ +/** + * Create a new dashboard with formula and function distribution widget + */ + +import { client, v1 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v1.DashboardsApi(configuration); + +const params: v1.DashboardsApiCreateDashboardRequest = { + body: { + title: "Example-Dashboard", + widgets: [ + { + layout: { + x: 0, + y: 0, + width: 47, + height: 15, + }, + definition: { + title: "", + titleSize: "16", + titleAlign: "left", + time: {}, + type: "distribution", + requests: [ + { + responseFormat: "scalar", + queries: [ + { + dataSource: "logs", + name: "query1", + search: { + query: "", + }, + indexes: ["*"], + compute: { + aggregation: "avg", + metric: "@duration", + }, + groupBy: [ + { + facet: "service", + limit: 1000, + sort: { + aggregation: "count", + order: "desc", + }, + }, + ], + storage: "hot", + }, + ], + }, + ], + }, + }, + ], + templateVariables: [], + layoutType: "free", + notifyList: [], + }, +}; + +apiInstance + .createDashboard(params) + .then((data: v1.Dashboard) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }) + .catch((error: any) => console.error(error)); diff --git a/examples/v1/dashboards/CreateDashboard_2823363212.ts b/examples/v1/dashboards/CreateDashboard_2823363212.ts new file mode 100644 index 000000000000..931dabdfd7ee --- /dev/null +++ b/examples/v1/dashboards/CreateDashboard_2823363212.ts @@ -0,0 +1,69 @@ +/** + * Create a new dashboard with heatmap widget with markers and num_buckets + */ + +import { client, v1 } from "@datadog/datadog-api-client"; + +const configuration = client.createConfiguration(); +const apiInstance = new v1.DashboardsApi(configuration); + +const params: v1.DashboardsApiCreateDashboardRequest = { + body: { + title: "Example-Dashboard", + widgets: [ + { + definition: { + title: "", + titleSize: "16", + titleAlign: "left", + type: "heatmap", + xaxis: { + numBuckets: 75, + }, + yaxis: { + scale: "linear", + min: "auto", + max: "auto", + includeZero: true, + }, + markers: [ + { + displayType: "percentile", + value: "50", + }, + { + displayType: "percentile", + value: "99", + }, + ], + requests: [ + { + requestType: "histogram", + query: { + dataSource: "metrics", + name: "query1", + query: "histogram:trace.servlet.request{*}", + }, + }, + ], + }, + layout: { + x: 0, + y: 0, + width: 4, + height: 4, + }, + }, + ], + layoutType: "ordered", + }, +}; + +apiInstance + .createDashboard(params) + .then((data: v1.Dashboard) => { + console.log( + "API called successfully. Returned data: " + JSON.stringify(data) + ); + }) + .catch((error: any) => console.error(error)); diff --git a/features/v1/dashboards.feature b/features/v1/dashboards.feature index 588c609ceddb..076546114f1f 100644 --- a/features/v1/dashboards.feature +++ b/features/v1/dashboards.feature @@ -368,6 +368,15 @@ Feature: Dashboards And the response "widgets[0].definition.requests[0].apm_stats_query.service" is equal to "cassandra" And the response "widgets[0].definition.requests[0].apm_stats_query.name" is equal to "cassandra.query" + @team:DataDog/dashboards-backend + Scenario: Create a new dashboard with distribution widget with markers and num_buckets + Given new "CreateDashboard" request + And body with value { "title": "{{ unique }}", "widgets": [{"definition": { "title": "", "title_size": "16", "title_align": "left", "type": "distribution", "xaxis": { "scale": "linear", "min": "auto", "max": "auto", "include_zero": true, "num_buckets": 55 }, "yaxis": { "scale": "linear", "min": "auto", "max": "auto", "include_zero": true }, "markers": [{ "display_type": "percentile", "value": "50" }, { "display_type": "percentile", "value": "99" }, { "display_type": "percentile", "value": "90" }], "requests": [{ "response_format": "scalar", "queries": [{ "data_source": "metrics", "name": "query1", "query": "avg:system.cpu.user{*} by {service}", "aggregator": "avg" }] }] }, "layout": { "x": 0, "y": 0, "width": 4, "height": 4 } } ], "layout_type": "ordered" } + When the request is sent + Then the response status is 200 OK + And the response "widgets[0].definition.xaxis.num_buckets" is equal to 55 + And the response "widgets[0].definition.markers" is equal to [{"display_type": "percentile", "value": "50"}, {"display_type": "percentile", "value": "99"}, {"display_type": "percentile", "value": "90"}] + @team:DataDog/dashboards-backend Scenario: Create a new dashboard with event_stream list_stream widget Given new "CreateDashboard" request @@ -397,6 +406,20 @@ Feature: Dashboards And the response "widgets[0].definition.type" is equal to "event_timeline" And the response "widgets[0].definition.query" is equal to "status:error priority:all" + @team:DataDog/dashboards-backend + Scenario: Create a new dashboard with formula and function distribution widget + Given new "CreateDashboard" request + And body with value {"title": "{{ unique }}", "widgets": [{"layout": {"x": 0, "y": 0, "width": 47, "height": 15}, "definition": {"title": "", "title_size": "16", "title_align": "left", "time": {}, "type": "distribution", "requests": [{"response_format": "scalar", "queries": [{"data_source": "logs", "name": "query1", "search": {"query": ""}, "indexes": ["*"], "compute": {"aggregation": "avg", "metric": "@duration"}, "group_by": [{"facet": "service", "limit": 1000, "sort": {"aggregation": "count", "order": "desc"}}], "storage": "hot"}]}]}}], "template_variables": [], "layout_type": "free", "notify_list": []} + When the request is sent + Then the response status is 200 OK + And the response "widgets[0].definition.type" is equal to "distribution" + And the response "widgets[0].definition.requests[0].response_format" is equal to "scalar" + And the response "widgets[0].definition.requests[0].queries[0].data_source" is equal to "logs" + And the response "widgets[0].definition.requests[0].queries[0].name" is equal to "query1" + And the response "widgets[0].definition.requests[0].queries[0].compute.aggregation" is equal to "avg" + And the response "widgets[0].definition.requests[0].queries[0].compute.metric" is equal to "@duration" + And the response "widgets[0].definition.requests[0].queries[0].group_by[0].facet" is equal to "service" + @team:DataDog/dashboards-backend Scenario: Create a new dashboard with formula and function heatmap widget Given new "CreateDashboard" request @@ -471,6 +494,15 @@ Feature: Dashboards And the response "widgets[0].definition.type" is equal to "heatmap" And the response "widgets[0].definition.requests[0].q" is equal to "avg:system.cpu.user{*} by {service}" + @team:DataDog/dashboards-backend + Scenario: Create a new dashboard with heatmap widget with markers and num_buckets + Given new "CreateDashboard" request + And body with value { "title": "{{ unique }}", "widgets": [{"definition": { "title": "", "title_size": "16", "title_align": "left", "type": "heatmap", "xaxis": { "num_buckets": 75 }, "yaxis": { "scale": "linear", "min": "auto", "max": "auto", "include_zero": true }, "markers": [{ "display_type": "percentile", "value": "50" }, { "display_type": "percentile", "value": "99" }], "requests": [{ "request_type": "histogram", "query": { "data_source": "metrics", "name": "query1", "query": "histogram:trace.servlet.request{*}"} }] }, "layout": { "x": 0, "y": 0, "width": 4, "height": 4 } }], "layout_type": "ordered" } + When the request is sent + Then the response status is 200 OK + And the response "widgets[0].definition.xaxis.num_buckets" is equal to 75 + And the response "widgets[0].definition.markers" is equal to [{"display_type": "percentile", "value": "50"}, {"display_type": "percentile", "value": "99"}] + @team:DataDog/dashboards-backend Scenario: Create a new dashboard with hostmap widget Given new "CreateDashboard" request diff --git a/packages/datadog-api-client-v1/index.ts b/packages/datadog-api-client-v1/index.ts index de7810e2a7cc..1b622d85024b 100644 --- a/packages/datadog-api-client-v1/index.ts +++ b/packages/datadog-api-client-v1/index.ts @@ -420,7 +420,6 @@ export { DistributionPointsType } from "./models/DistributionPointsType"; export { DistributionWidgetDefinition } from "./models/DistributionWidgetDefinition"; export { DistributionWidgetDefinitionType } from "./models/DistributionWidgetDefinitionType"; export { DistributionWidgetHistogramRequestQuery } from "./models/DistributionWidgetHistogramRequestQuery"; -export { DistributionWidgetHistogramRequestType } from "./models/DistributionWidgetHistogramRequestType"; export { DistributionWidgetRequest } from "./models/DistributionWidgetRequest"; export { DistributionWidgetXAxis } from "./models/DistributionWidgetXAxis"; export { DistributionWidgetYAxis } from "./models/DistributionWidgetYAxis"; @@ -493,6 +492,7 @@ export { GroupWidgetDefinitionType } from "./models/GroupWidgetDefinitionType"; export { HeatMapWidgetDefinition } from "./models/HeatMapWidgetDefinition"; export { HeatMapWidgetDefinitionType } from "./models/HeatMapWidgetDefinitionType"; export { HeatMapWidgetRequest } from "./models/HeatMapWidgetRequest"; +export { HeatMapWidgetXAxis } from "./models/HeatMapWidgetXAxis"; export { Host } from "./models/Host"; export { HostListResponse } from "./models/HostListResponse"; export { HostMapRequest } from "./models/HostMapRequest"; @@ -1245,6 +1245,7 @@ export { WidgetFormulaSort } from "./models/WidgetFormulaSort"; export { WidgetFormulaStyle } from "./models/WidgetFormulaStyle"; export { WidgetGrouping } from "./models/WidgetGrouping"; export { WidgetGroupSort } from "./models/WidgetGroupSort"; +export { WidgetHistogramRequestType } from "./models/WidgetHistogramRequestType"; export { WidgetHorizontalAlign } from "./models/WidgetHorizontalAlign"; export { WidgetImageSizing } from "./models/WidgetImageSizing"; export { WidgetLayout } from "./models/WidgetLayout"; diff --git a/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts b/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts index 0f17abc625a5..8c7458e0883a 100644 --- a/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts +++ b/packages/datadog-api-client-v1/models/DistributionWidgetRequest.ts @@ -5,9 +5,12 @@ */ import { ApmStatsQueryDefinition } from "./ApmStatsQueryDefinition"; import { DistributionWidgetHistogramRequestQuery } from "./DistributionWidgetHistogramRequestQuery"; -import { DistributionWidgetHistogramRequestType } from "./DistributionWidgetHistogramRequestType"; +import { FormulaAndFunctionQueryDefinition } from "./FormulaAndFunctionQueryDefinition"; +import { FormulaAndFunctionResponseFormat } from "./FormulaAndFunctionResponseFormat"; import { LogQueryDefinition } from "./LogQueryDefinition"; import { ProcessQueryDefinition } from "./ProcessQueryDefinition"; +import { WidgetFormula } from "./WidgetFormula"; +import { WidgetHistogramRequestType } from "./WidgetHistogramRequestType"; import { WidgetStyle } from "./WidgetStyle"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; @@ -28,6 +31,10 @@ export class DistributionWidgetRequest { * The log query. */ "eventQuery"?: LogQueryDefinition; + /** + * List of formulas that operate on queries. + */ + "formulas"?: Array; /** * The log query. */ @@ -48,6 +55,10 @@ export class DistributionWidgetRequest { * Widget query. */ "q"?: string; + /** + * List of queries that can be returned directly or used in formulas. + */ + "queries"?: Array; /** * Query definition for Distribution Widget Histogram Request */ @@ -55,7 +66,11 @@ export class DistributionWidgetRequest { /** * Request type for the histogram request. */ - "requestType"?: DistributionWidgetHistogramRequestType; + "requestType"?: WidgetHistogramRequestType; + /** + * Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. + */ + "responseFormat"?: FormulaAndFunctionResponseFormat; /** * The log query. */ @@ -97,6 +112,10 @@ export class DistributionWidgetRequest { baseName: "event_query", type: "LogQueryDefinition", }, + formulas: { + baseName: "formulas", + type: "Array", + }, logQuery: { baseName: "log_query", type: "LogQueryDefinition", @@ -117,13 +136,21 @@ export class DistributionWidgetRequest { baseName: "q", type: "string", }, + queries: { + baseName: "queries", + type: "Array", + }, query: { baseName: "query", type: "DistributionWidgetHistogramRequestQuery", }, requestType: { baseName: "request_type", - type: "DistributionWidgetHistogramRequestType", + type: "WidgetHistogramRequestType", + }, + responseFormat: { + baseName: "response_format", + type: "FormulaAndFunctionResponseFormat", }, rumQuery: { baseName: "rum_query", diff --git a/packages/datadog-api-client-v1/models/DistributionWidgetXAxis.ts b/packages/datadog-api-client-v1/models/DistributionWidgetXAxis.ts index 7868e1d6186e..425dd7e01e1a 100644 --- a/packages/datadog-api-client-v1/models/DistributionWidgetXAxis.ts +++ b/packages/datadog-api-client-v1/models/DistributionWidgetXAxis.ts @@ -22,6 +22,10 @@ export class DistributionWidgetXAxis { * Specifies minimum value to show on the x-axis. It takes a number, percentile (p90 === 90th percentile), or auto for default behavior. */ "min"?: string; + /** + * Number of value buckets to target, also known as the resolution of the value bins. + */ + "numBuckets"?: number; /** * Specifies the scale type. Possible values are `linear`. */ @@ -55,6 +59,11 @@ export class DistributionWidgetXAxis { baseName: "min", type: "string", }, + numBuckets: { + baseName: "num_buckets", + type: "number", + format: "int64", + }, scale: { baseName: "scale", type: "string", diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts index 60c9cbd6e614..71691e231ea8 100644 --- a/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts +++ b/packages/datadog-api-client-v1/models/HeatMapWidgetDefinition.ts @@ -5,9 +5,11 @@ */ import { HeatMapWidgetDefinitionType } from "./HeatMapWidgetDefinitionType"; import { HeatMapWidgetRequest } from "./HeatMapWidgetRequest"; +import { HeatMapWidgetXAxis } from "./HeatMapWidgetXAxis"; import { WidgetAxis } from "./WidgetAxis"; import { WidgetCustomLink } from "./WidgetCustomLink"; import { WidgetEvent } from "./WidgetEvent"; +import { WidgetMarker } from "./WidgetMarker"; import { WidgetTextAlign } from "./WidgetTextAlign"; import { WidgetTime } from "./WidgetTime"; @@ -29,6 +31,10 @@ export class HeatMapWidgetDefinition { * Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto". */ "legendSize"?: string; + /** + * List of markers. + */ + "markers"?: Array; /** * List of widget types. */ @@ -57,6 +63,10 @@ export class HeatMapWidgetDefinition { * Type of the heat map widget. */ "type": HeatMapWidgetDefinitionType; + /** + * X Axis controls for the heat map widget. + */ + "xaxis"?: HeatMapWidgetXAxis; /** * Axis controls for the widget. */ @@ -90,6 +100,10 @@ export class HeatMapWidgetDefinition { baseName: "legend_size", type: "string", }, + markers: { + baseName: "markers", + type: "Array", + }, requests: { baseName: "requests", type: "[HeatMapWidgetRequest]", @@ -120,6 +134,10 @@ export class HeatMapWidgetDefinition { type: "HeatMapWidgetDefinitionType", required: true, }, + xaxis: { + baseName: "xaxis", + type: "HeatMapWidgetXAxis", + }, yaxis: { baseName: "yaxis", type: "WidgetAxis", diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts index 62f694881a5a..2fbc3a91a068 100644 --- a/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts +++ b/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts @@ -4,11 +4,13 @@ * Copyright 2020-Present Datadog, Inc. */ import { EventQueryDefinition } from "./EventQueryDefinition"; +import { FormulaAndFunctionMetricQueryDefinition } from "./FormulaAndFunctionMetricQueryDefinition"; import { FormulaAndFunctionQueryDefinition } from "./FormulaAndFunctionQueryDefinition"; import { FormulaAndFunctionResponseFormat } from "./FormulaAndFunctionResponseFormat"; import { LogQueryDefinition } from "./LogQueryDefinition"; import { ProcessQueryDefinition } from "./ProcessQueryDefinition"; import { WidgetFormula } from "./WidgetFormula"; +import { WidgetHistogramRequestType } from "./WidgetHistogramRequestType"; import { WidgetStyle } from "./WidgetStyle"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; @@ -53,6 +55,14 @@ export class HeatMapWidgetRequest { * List of queries that can be returned directly or used in formulas. */ "queries"?: Array; + /** + * A formula and functions metrics query. + */ + "query"?: FormulaAndFunctionMetricQueryDefinition; + /** + * Request type for the histogram request. + */ + "requestType"?: WidgetHistogramRequestType; /** * Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. */ @@ -122,6 +132,14 @@ export class HeatMapWidgetRequest { baseName: "queries", type: "Array", }, + query: { + baseName: "query", + type: "FormulaAndFunctionMetricQueryDefinition", + }, + requestType: { + baseName: "request_type", + type: "WidgetHistogramRequestType", + }, responseFormat: { baseName: "response_format", type: "FormulaAndFunctionResponseFormat", diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetXAxis.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetXAxis.ts new file mode 100644 index 000000000000..07327f19d24f --- /dev/null +++ b/packages/datadog-api-client-v1/models/HeatMapWidgetXAxis.ts @@ -0,0 +1,53 @@ +/** + * Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License. + * This product includes software developed at Datadog (https://www.datadoghq.com/). + * Copyright 2020-Present Datadog, Inc. + */ + +import { AttributeTypeMap } from "../../datadog-api-client-common/util"; + +/** + * X Axis controls for the heat map widget. + */ +export class HeatMapWidgetXAxis { + /** + * Number of time buckets to target, also known as the resolution of the time bins. This is only applicable for distribution of points (group distributions use the roll-up modifier). + */ + "numBuckets"?: number; + + /** + * A container for additional, undeclared properties. + * This is a holder for any undeclared properties as specified with + * the 'additionalProperties' keyword in the OAS document. + */ + "additionalProperties"?: { [key: string]: any }; + + /** + * @ignore + */ + "_unparsed"?: boolean; + + /** + * @ignore + */ + static readonly attributeTypeMap: AttributeTypeMap = { + numBuckets: { + baseName: "num_buckets", + type: "number", + format: "int64", + }, + additionalProperties: { + baseName: "additionalProperties", + type: "{ [key: string]: any; }", + }, + }; + + /** + * @ignore + */ + static getAttributeTypeMap(): AttributeTypeMap { + return HeatMapWidgetXAxis.attributeTypeMap; + } + + public constructor() {} +} diff --git a/packages/datadog-api-client-v1/models/ObjectSerializer.ts b/packages/datadog-api-client-v1/models/ObjectSerializer.ts index 353dc1d85e2b..167a2c79ba94 100644 --- a/packages/datadog-api-client-v1/models/ObjectSerializer.ts +++ b/packages/datadog-api-client-v1/models/ObjectSerializer.ts @@ -106,6 +106,7 @@ import { HTTPLogError } from "./HTTPLogError"; import { HTTPLogItem } from "./HTTPLogItem"; import { HeatMapWidgetDefinition } from "./HeatMapWidgetDefinition"; import { HeatMapWidgetRequest } from "./HeatMapWidgetRequest"; +import { HeatMapWidgetXAxis } from "./HeatMapWidgetXAxis"; import { Host } from "./Host"; import { HostListResponse } from "./HostListResponse"; import { HostMapRequest } from "./HostMapRequest"; @@ -718,7 +719,6 @@ const enumsMap: { [key: string]: any[] } = { DistributionPointsContentEncoding: ["deflate"], DistributionPointsType: ["distribution"], DistributionWidgetDefinitionType: ["distribution"], - DistributionWidgetHistogramRequestType: ["histogram"], EventAlertType: [ "error", "warning", @@ -1622,6 +1622,7 @@ const enumsMap: { [key: string]: any[] } = { WidgetFormulaCellDisplayModeOptionsTrendType: ["area", "line", "bars"], WidgetFormulaCellDisplayModeOptionsYScale: ["shared", "independent"], WidgetGrouping: ["check", "cluster"], + WidgetHistogramRequestType: ["histogram"], WidgetHorizontalAlign: ["center", "left", "right"], WidgetImageSizing: [ "fill", @@ -1846,6 +1847,7 @@ const typeMap: { [index: string]: any } = { HTTPLogItem: HTTPLogItem, HeatMapWidgetDefinition: HeatMapWidgetDefinition, HeatMapWidgetRequest: HeatMapWidgetRequest, + HeatMapWidgetXAxis: HeatMapWidgetXAxis, Host: Host, HostListResponse: HostListResponse, HostMapRequest: HostMapRequest, diff --git a/packages/datadog-api-client-v1/models/DistributionWidgetHistogramRequestType.ts b/packages/datadog-api-client-v1/models/WidgetHistogramRequestType.ts similarity index 81% rename from packages/datadog-api-client-v1/models/DistributionWidgetHistogramRequestType.ts rename to packages/datadog-api-client-v1/models/WidgetHistogramRequestType.ts index 5742c9cda9ae..74e817892e78 100644 --- a/packages/datadog-api-client-v1/models/DistributionWidgetHistogramRequestType.ts +++ b/packages/datadog-api-client-v1/models/WidgetHistogramRequestType.ts @@ -10,7 +10,5 @@ import { UnparsedObject } from "../../datadog-api-client-common/util"; * Request type for the histogram request. */ -export type DistributionWidgetHistogramRequestType = - | typeof HISTOGRAM - | UnparsedObject; +export type WidgetHistogramRequestType = typeof HISTOGRAM | UnparsedObject; export const HISTOGRAM = "histogram"; diff --git a/packages/datadog-api-client-v1/models/WidgetMarker.ts b/packages/datadog-api-client-v1/models/WidgetMarker.ts index f55a6e4244c4..346f43332b63 100644 --- a/packages/datadog-api-client-v1/models/WidgetMarker.ts +++ b/packages/datadog-api-client-v1/models/WidgetMarker.ts @@ -14,7 +14,7 @@ export class WidgetMarker { * Combination of: * - A severity error, warning, ok, or info * - A line type: dashed, solid, or bold - * In this case of a Distribution widget, this can be set to be `x_axis_percentile`. + * In this case of a Distribution widget, this can be set to be `percentile`. */ "displayType"?: string; /** @@ -27,6 +27,7 @@ export class WidgetMarker { "time"?: string; /** * Value to apply. Can be a single value y = 15 or a range of values 0 < y < 10. + * For Distribution widgets with `display_type` set to `percentile`, this should be a numeric percentile value (for example, "90" for P90). */ "value": string;