Regenerate client from commit 9f3c740 of spec repo (#473)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit 7ab12b307011 · 2022-01-13T08:22:54.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2022-01-12 15:42:12.238883",
-            "spec_repo_commit": "9a4c69f"
+            "regenerated": "2022-01-12 16:37:00.597589",
+            "spec_repo_commit": "9f3c740"
         },
         "v2": {
             "apigentools_version": "1.5.1.dev2",
-            "regenerated": "2022-01-12 15:42:12.264357",
-            "spec_repo_commit": "9a4c69f"
+            "regenerated": "2022-01-12 16:37:00.624199",
+            "spec_repo_commit": "9f3c740"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -12260,9 +12260,6 @@ components:
       required:
       - type
       - requests
-      - size_by
-      - color_by
-      - group_by
       type: object
     TreeMapWidgetDefinitionType:
       default: treemap
@@ -12276,9 +12273,23 @@ components:
     TreeMapWidgetRequest:
       description: An updated treemap widget.
       properties:
+        formulas:
+          description: List of formulas that operate on queries. **This feature is
+            currently in beta.**
+          items:
+            $ref: '#/components/schemas/WidgetFormula'
+          type: array
         q:
           description: The widget metrics query.
           type: string
+        queries:
+          description: List of queries that can be returned directly or used in formulas.
+            **This feature is currently in beta.**
+          items:
+            $ref: '#/components/schemas/FormulaAndFunctionQueryDefinition'
+          type: array
+        response_format:
+          $ref: '#/components/schemas/FormulaAndFunctionResponseFormat'
       type: object
     UsageAnalyzedLogsHour:
       description: The number of analyzed logs for each hour for a given organization.
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-formulas-and-functions-treemap-widget_3677864300/frozen.json b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-formulas-and-functions-treemap-widget_3677864300/frozen.json
@@ -0,0 +1 @@
+"2022-01-12T10:11:31.394Z"
diff --git a/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-formulas-and-functions-treemap-widget_3677864300/recording.har b/cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-a-formulas-and-functions-treemap-widget_3677864300/recording.har
@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with a formulas and functions treemap widget",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "5.1.1"
+    },
+    "entries": [
+      {
+        "_id": "14594ccf095daa90968969cdd40b4adb",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 467,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 475,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"layout_type\":\"ordered\",\"title\":\"Test-Create_a_new_dashboard_with_a_formulas_and_functions_treemap_widget-1641982291\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"hour_before(query1)\"},{\"formula\":\"query1\"}],\"queries\":[{\"compute\":{\"aggregation\":\"count\"},\"data_source\":\"logs\",\"group_by\":[],\"indexes\":[\"*\"],\"name\":\"query1\",\"search\":{\"query\":\"\"}}],\"response_format\":\"scalar\"}],\"title\":\"\",\"type\":\"treemap\"},\"layout\":{\"height\":4,\"width\":4,\"x\":0,\"y\":0}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 873,
+          "content": {
+            "mimeType": "application/json",
+            "size": 873,
+            "text": "{\"notify_list\":null,\"description\":null,\"restricted_roles\":[],\"author_name\":null,\"template_variables\":null,\"is_read_only\":false,\"id\":\"2ar-acj-hxc\",\"title\":\"Test-Create_a_new_dashboard_with_a_formulas_and_functions_treemap_widget-1641982291\",\"url\":\"/dashboard/2ar-acj-hxc/test-createanewdashboardwithaformulasandfunctionstreemapwidget-1641982291\",\"created_at\":\"2022-01-12T10:11:31.601485+00:00\",\"modified_at\":\"2022-01-12T10:11:31.601485+00:00\",\"author_handle\":\"frog@datadoghq.com\",\"widgets\":[{\"definition\":{\"requests\":[{\"formulas\":[{\"formula\":\"hour_before(query1)\"},{\"formula\":\"query1\"}],\"response_format\":\"scalar\",\"queries\":[{\"search\":{\"query\":\"\"},\"data_source\":\"logs\",\"compute\":{\"aggregation\":\"count\"},\"name\":\"query1\",\"indexes\":[\"*\"],\"group_by\":[]}]}],\"type\":\"treemap\",\"title\":\"\"},\"layout\":{\"y\":0,\"width\":4,\"x\":0,\"height\":4},\"id\":2836171994664464}],\"layout_type\":\"ordered\"}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 383,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-01-12T10:11:31.410Z",
+        "time": 229
+      },
+      {
+        "_id": "657dda1a8731f8491b143842fe7d0347",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 436,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/2ar-acj-hxc"
+        },
+        "response": {
+          "bodySize": 38,
+          "content": {
+            "mimeType": "application/json",
+            "size": 38,
+            "text": "{\"deleted_dashboard_id\":\"2ar-acj-hxc\"}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 382,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2022-01-12T10:11:31.649Z",
+        "time": 146
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}
diff --git a/examples/v1/dashboards/CreateDashboard_1024858348.ts b/examples/v1/dashboards/CreateDashboard_1024858348.ts
@@ -0,0 +1,66 @@
+/**
+ * Create a new dashboard with a formulas and functions treemap widget
+ */
+
+import { v1 } from "@datadog/datadog-api-client";
+
+const configuration = v1.createConfiguration();
+const apiInstance = new v1.DashboardsApi(configuration);
+
+let params: v1.DashboardsApiCreateDashboardRequest = {
+  body: {
+    title:
+      "Example-Create_a_new_dashboard_with_a_formulas_and_functions_treemap_widget",
+    widgets: [
+      {
+        definition: {
+          title: "",
+          type: "treemap",
+          requests: [
+            {
+              formulas: [
+                {
+                  formula: "hour_before(query1)",
+                },
+                {
+                  formula: "query1",
+                },
+              ],
+              queries: [
+                {
+                  dataSource: "logs",
+                  name: "query1",
+                  search: {
+                    query: "",
+                  },
+                  indexes: ["*"],
+                  compute: {
+                    aggregation: "count",
+                  },
+                  groupBy: [],
+                },
+              ],
+              responseFormat: "scalar",
+            },
+          ],
+        },
+        layout: {
+          x: 0,
+          y: 0,
+          width: 4,
+          height: 4,
+        },
+      },
+    ],
+    layoutType: "ordered",
+  },
+};
+
+apiInstance
+  .createDashboard(params)
+  .then((data: any) => {
+    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
@@ -41,6 +41,19 @@ Feature: Dashboards
     And the response "widgets[0].definition.requests[0].formulas[0].formula" is equal to "hour_before(query1)"
     And the response "widgets[0].definition.requests[0].formulas[1].formula" is equal to "query1"
 
+  @team:DataDog/dashboards
+  Scenario: Create a new dashboard with a formulas and functions treemap widget
+    Given new "CreateDashboard" request
+    And body with value { "title": "{{ unique }}", "widgets": [ { "definition": { "title": "", "type": "treemap", "requests": [ { "formulas": [ { "formula": "hour_before(query1)" }, { "formula": "query1" } ], "queries": [ { "data_source": "logs", "name": "query1", "search": { "query": "" }, "indexes": [ "*" ], "compute": { "aggregation": "count" }, "group_by": [] } ], "response_format": "scalar" } ] }, "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.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 "count"
+    And the response "widgets[0].definition.requests[0].formulas[0].formula" is equal to "hour_before(query1)"
+    And the response "widgets[0].definition.requests[0].formulas[1].formula" is equal to "query1"
+
   @team:DataDog/dashboards
   Scenario: Create a new dashboard with a query value widget using the percentile aggregator
     Given new "CreateDashboard" request
diff --git a/packages/datadog-api-client-v1/models/TreeMapWidgetDefinition.ts b/packages/datadog-api-client-v1/models/TreeMapWidgetDefinition.ts
@@ -20,13 +20,13 @@ import { AttributeTypeMap } from "./ObjectSerializer";
  */
 
 export class TreeMapWidgetDefinition {
-  "colorBy": TreeMapColorBy;
-  "groupBy": TreeMapGroupBy;
+  "colorBy"?: TreeMapColorBy;
+  "groupBy"?: TreeMapGroupBy;
   /**
    * List of top list widget requests.
    */
   "requests": Array<TreeMapWidgetRequest>;
-  "sizeBy": TreeMapSizeBy;
+  "sizeBy"?: TreeMapSizeBy;
   /**
    * Title of your widget.
    */
@@ -39,12 +39,10 @@ export class TreeMapWidgetDefinition {
     colorBy: {
       baseName: "color_by",
       type: "TreeMapColorBy",
-      required: true,
     },
     groupBy: {
       baseName: "group_by",
       type: "TreeMapGroupBy",
-      required: true,
     },
     requests: {
       baseName: "requests",
@@ -54,7 +52,6 @@ export class TreeMapWidgetDefinition {
     sizeBy: {
       baseName: "size_by",
       type: "TreeMapSizeBy",
-      required: true,
     },
     title: {
       baseName: "title",
diff --git a/packages/datadog-api-client-v1/models/TreeMapWidgetRequest.ts b/packages/datadog-api-client-v1/models/TreeMapWidgetRequest.ts
@@ -8,25 +8,49 @@
  * Do not edit the class manually.
  */
 
+import { FormulaAndFunctionQueryDefinition } from "./FormulaAndFunctionQueryDefinition";
+import { FormulaAndFunctionResponseFormat } from "./FormulaAndFunctionResponseFormat";
+import { WidgetFormula } from "./WidgetFormula";
 import { AttributeTypeMap } from "./ObjectSerializer";
 
 /**
  * An updated treemap widget.
  */
 
 export class TreeMapWidgetRequest {
+  /**
+   * List of formulas that operate on queries. **This feature is currently in beta.**
+   */
+  "formulas"?: Array<WidgetFormula>;
   /**
    * The widget metrics query.
    */
   "q"?: string;
+  /**
+   * List of queries that can be returned directly or used in formulas. **This feature is currently in beta.**
+   */
+  "queries"?: Array<FormulaAndFunctionQueryDefinition>;
+  "responseFormat"?: FormulaAndFunctionResponseFormat;
 
   "unparsedObject"?: any;
 
   static readonly attributeTypeMap: AttributeTypeMap = {
+    formulas: {
+      baseName: "formulas",
+      type: "Array<WidgetFormula>",
+    },
     q: {
       baseName: "q",
       type: "string",
     },
+    queries: {
+      baseName: "queries",
+      type: "Array<FormulaAndFunctionQueryDefinition>",
+    },
+    responseFormat: {
+      baseName: "response_format",
+      type: "FormulaAndFunctionResponseFormat",
+    },
   };
 
   static getAttributeTypeMap(): AttributeTypeMap {

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.5.1.dev2",`
`7`		`- "regenerated": "2022-01-12 15:42:12.238883",`
`8`		`- "spec_repo_commit": "9a4c69f"`
	`7`	`+ "regenerated": "2022-01-12 16:37:00.597589",`
	`8`	`+ "spec_repo_commit": "9f3c740"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.5.1.dev2",`
`12`		`- "regenerated": "2022-01-12 15:42:12.264357",`
`13`		`- "spec_repo_commit": "9a4c69f"`
	`12`	`+ "regenerated": "2022-01-12 16:37:00.624199",`
	`13`	`+ "spec_repo_commit": "9f3c740"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`