From 2f757f2319cf68a07fc33ee73b6afce40b9bb784 Mon Sep 17 00:00:00 2001 From: "ci.datadog-api-spec" Date: Wed, 13 Sep 2023 14:38:43 +0000 Subject: [PATCH] Regenerate client from commit ec46249d of spec repo --- .apigentools-info | 8 +- .generator/schemas/v1/openapi.yaml | 12 ++ .../frozen.json | 1 + .../recording.har | 110 ++++++++++++++++++ .../dashboards/CreateDashboard_3777304439.ts | 64 ++++++++++ features/v1/dashboards.feature | 11 ++ .../models/HeatMapWidgetRequest.ts | 27 +++++ 7 files changed, 229 insertions(+), 4 deletions(-) create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/frozen.json create mode 100644 cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/recording.har create mode 100644 examples/v1/dashboards/CreateDashboard_3777304439.ts diff --git a/.apigentools-info b/.apigentools-info index 2f04b154d360..9fd8ee6b7511 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.5", - "regenerated": "2023-09-12 20:28:17.290809", - "spec_repo_commit": "bc2ae18f" + "regenerated": "2023-09-13 14:37:15.420184", + "spec_repo_commit": "ec46249d" }, "v2": { "apigentools_version": "1.6.5", - "regenerated": "2023-09-12 20:28:17.303876", - "spec_repo_commit": "bc2ae18f" + "regenerated": "2023-09-13 14:37:15.436584", + "spec_repo_commit": "ec46249d" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index bec74a524243..dba899d4ac45 100644 --- a/.generator/schemas/v1/openapi.yaml +++ b/.generator/schemas/v1/openapi.yaml @@ -3422,6 +3422,11 @@ components: $ref: '#/components/schemas/LogQueryDefinition' event_query: $ref: '#/components/schemas/EventQueryDefinition' + formulas: + description: List of formulas that operate on queries. + items: + $ref: '#/components/schemas/WidgetFormula' + type: array log_query: $ref: '#/components/schemas/LogQueryDefinition' network_query: @@ -3433,6 +3438,13 @@ 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 + response_format: + $ref: '#/components/schemas/FormulaAndFunctionResponseFormat' rum_query: $ref: '#/components/schemas/LogQueryDefinition' security_query: diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/frozen.json new file mode 100644 index 000000000000..5e40d429091f --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/frozen.json @@ -0,0 +1 @@ +"2023-09-12T19:51:40.932Z" diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/recording.har new file mode 100644 index 000000000000..0420b5cc2964 --- /dev/null +++ b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-formula-and-function-heatmap-widget_4048655771/recording.har @@ -0,0 +1,110 @@ +{ + "log": { + "_recordingName": "Dashboards/Create a new dashboard with formula and function heatmap widget", + "creator": { + "comment": "persister:fs", + "name": "Polly.JS", + "version": "6.0.5" + }, + "entries": [ + { + "_id": "2c3b89238cc7caa5503006df123a1604", + "_order": 0, + "cache": {}, + "request": { + "bodySize": 527, + "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": "{\"is_read_only\":false,\"layout_type\":\"free\",\"notify_list\":[],\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_formula_and_function_heatmap_widget-1694548300\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\",\"style\":{\"palette\":\"dog_classic\"}}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"heatmap\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0}}]}" + }, + "queryString": [], + "url": "https://api.datadoghq.com/api/v1/dashboard" + }, + "response": { + "bodySize": 864, + "content": { + "mimeType": "application/json", + "size": 864, + "text": "{\"id\":\"agm-reh-km8\",\"title\":\"Test-Create_a_new_dashboard_with_formula_and_function_heatmap_widget-1694548300\",\"description\":null,\"author_handle\":\"frog@datadoghq.com\",\"author_name\":null,\"layout_type\":\"free\",\"url\":\"/dashboard/agm-reh-km8/test-createanewdashboardwithformulaandfunctionheatmapwidget-1694548300\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"query1\"}],\"queries\":[{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\",\"style\":{\"palette\":\"dog_classic\"}}],\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"heatmap\"},\"layout\":{\"height\":15,\"width\":47,\"x\":0,\"y\":0},\"id\":658874190518028}],\"notify_list\":[],\"created_at\":\"2023-09-12T19:51:41.163760+00:00\",\"modified_at\":\"2023-09-12T19:51:41.163760+00:00\",\"restricted_roles\":[]}\n" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 517, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2023-09-12T19:51:40.940Z", + "time": 290 + }, + { + "_id": "80d084303632271b710c1e318ec66d25", + "_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/agm-reh-km8" + }, + "response": { + "bodySize": 39, + "content": { + "mimeType": "application/json", + "size": 39, + "text": "{\"deleted_dashboard_id\":\"agm-reh-km8\"}\n" + }, + "cookies": [], + "headers": [ + { + "name": "content-type", + "value": "application/json" + } + ], + "headersSize": 516, + "httpVersion": "HTTP/1.1", + "redirectURL": "", + "status": 200, + "statusText": "OK" + }, + "startedDateTime": "2023-09-12T19:51:41.256Z", + "time": 192 + } + ], + "pages": [], + "version": "1.2" + } +} diff --git a/examples/v1/dashboards/CreateDashboard_3777304439.ts b/examples/v1/dashboards/CreateDashboard_3777304439.ts new file mode 100644 index 000000000000..db5b8b583081 --- /dev/null +++ b/examples/v1/dashboards/CreateDashboard_3777304439.ts @@ -0,0 +1,64 @@ +/** + * Create a new dashboard with formula and function heatmap 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: "heatmap", + requests: [ + { + responseFormat: "timeseries", + queries: [ + { + dataSource: "metrics", + name: "query1", + query: "avg:system.cpu.user{*}", + }, + ], + formulas: [ + { + formula: "query1", + }, + ], + style: { + palette: "dog_classic", + }, + }, + ], + }, + }, + ], + templateVariables: [], + layoutType: "free", + isReadOnly: false, + 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/features/v1/dashboards.feature b/features/v1/dashboards.feature index 89f45dbe1f9c..743a9b4efba2 100644 --- a/features/v1/dashboards.feature +++ b/features/v1/dashboards.feature @@ -324,6 +324,17 @@ 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 heatmap 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": "heatmap", "requests": [{"response_format": "timeseries", "queries": [{"data_source": "metrics", "name": "query1", "query": "avg:system.cpu.user{*}"}], "formulas": [{"formula": "query1"}], "style": {"palette": "dog_classic"}}]}}], "template_variables": [], "layout_type": "free", "is_read_only": false, "notify_list": []} + When the request is sent + Then the response status is 200 OK + And the response "widgets[0].definition.type" is equal to "heatmap" + And the response "widgets[0].definition.requests[0].queries[0].query" is equal to "avg:system.cpu.user{*}" + And the response "widgets[0].definition.requests[0].queries[0].data_source" is equal to "metrics" + And the response "widgets[0].definition.requests[0].style.palette" is equal to "dog_classic" + @team:DataDog/dashboards-backend Scenario: Create a new dashboard with formulas and functions scatterplot widget Given new "CreateDashboard" request diff --git a/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts b/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts index 6ea8d7a492ed..0e0364ea5cb4 100644 --- a/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts +++ b/packages/datadog-api-client-v1/models/HeatMapWidgetRequest.ts @@ -4,8 +4,11 @@ * Copyright 2020-Present Datadog, Inc. */ import { EventQueryDefinition } from "./EventQueryDefinition"; +import { FormulaAndFunctionQueryDefinition } from "./FormulaAndFunctionQueryDefinition"; +import { FormulaAndFunctionResponseFormat } from "./FormulaAndFunctionResponseFormat"; import { LogQueryDefinition } from "./LogQueryDefinition"; import { ProcessQueryDefinition } from "./ProcessQueryDefinition"; +import { WidgetFormula } from "./WidgetFormula"; import { WidgetStyle } from "./WidgetStyle"; import { AttributeTypeMap } from "../../datadog-api-client-common/util"; @@ -22,6 +25,10 @@ export class HeatMapWidgetRequest { * The event query. */ "eventQuery"?: EventQueryDefinition; + /** + * List of formulas that operate on queries. + */ + "formulas"?: Array; /** * The log query. */ @@ -42,6 +49,14 @@ export class HeatMapWidgetRequest { * Widget query. */ "q"?: string; + /** + * List of queries that can be returned directly or used in formulas. + */ + "queries"?: Array; + /** + * Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets. + */ + "responseFormat"?: FormulaAndFunctionResponseFormat; /** * The log query. */ @@ -72,6 +87,10 @@ export class HeatMapWidgetRequest { baseName: "event_query", type: "EventQueryDefinition", }, + formulas: { + baseName: "formulas", + type: "Array", + }, logQuery: { baseName: "log_query", type: "LogQueryDefinition", @@ -92,6 +111,14 @@ export class HeatMapWidgetRequest { baseName: "q", type: "string", }, + queries: { + baseName: "queries", + type: "Array", + }, + responseFormat: { + baseName: "response_format", + type: "FormulaAndFunctionResponseFormat", + }, rumQuery: { baseName: "rum_query", type: "LogQueryDefinition",