Add number_format to each formula in widget (#2056)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-02-19 19:09:51.941033",
-            "spec_repo_commit": "f0e5fdcf"
+            "regenerated": "2025-02-20 13:35:04.708998",
+            "spec_repo_commit": "c64543d0"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-02-19 19:09:51.956708",
-            "spec_repo_commit": "f0e5fdcf"
+            "regenerated": "2025-02-20 13:35:04.724917",
+            "spec_repo_commit": "c64543d0"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -9727,6 +9727,62 @@ components:
       items:
         $ref: '#/components/schemas/NotifyEndType'
       type: array
+    NumberFormatUnit:
+      description: Number format unit.
+      oneOf:
+      - $ref: '#/components/schemas/NumberFormatUnitCanonical'
+      - $ref: '#/components/schemas/NumberFormatUnitCustom'
+    NumberFormatUnitCanonical:
+      description: Canonical unit.
+      properties:
+        per_unit_name:
+          description: The name of the unit per item.
+          example: bytes
+          type: string
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitScaleType'
+        unit_name:
+          description: The name of the unit.
+          example: bytes
+          type: string
+      type: object
+    NumberFormatUnitCustom:
+      description: Custom unit.
+      properties:
+        label:
+          description: The label for the custom unit.
+          maxLength: 12
+          minLength: 1
+          type: string
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitCustomType'
+      type: object
+    NumberFormatUnitCustomType:
+      description: The type of custom unit.
+      enum:
+      - custom_unit_label
+      type: string
+      x-enum-varnames:
+      - CUSTOM_UNIT_LABEL
+    NumberFormatUnitScale:
+      description: The definition of `NumberFormatUnitScale` object.
+      nullable: true
+      properties:
+        type:
+          $ref: '#/components/schemas/NumberFormatUnitScaleType'
+        unit_name:
+          description: The name of the unit.
+          example: bytes
+          type: string
+      type: object
+    NumberFormatUnitScaleType:
+      description: The type of unit scale.
+      enum:
+      - canonical_unit
+      example: canonical_unit
+      type: string
+      x-enum-varnames:
+      - CANONICAL_UNIT
     OnMissingDataOption:
       description: 'Controls how groups or monitors are treated if an evaluation does
         not return any data points.
@@ -23044,6 +23100,8 @@ components:
           type: string
         limit:
           $ref: '#/components/schemas/WidgetFormulaLimit'
+        number_format:
+          $ref: '#/components/schemas/WidgetNumberFormat'
         style:
           $ref: '#/components/schemas/WidgetFormulaStyle'
       required:
@@ -23463,6 +23521,14 @@ components:
       x-enum-varnames:
       - HOST
       - CONTAINER
+    WidgetNumberFormat:
+      description: Number format options for the widget.
+      properties:
+        unit:
+          $ref: '#/components/schemas/NumberFormatUnit'
+        unit_scale:
+          $ref: '#/components/schemas/NumberFormatUnitScale'
+      type: object
     WidgetOrderBy:
       description: What to order by.
       enum:

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-timeseries-widget-with-custom_unit_1757563798/frozen.json

@@ -0,0 +1 @@
+"2025-02-17T16:50:56.669Z"

cassettes/v1/Dashboards_1335235736/Create-a-new-dashboard-with-timeseries-widget-with-custom_unit_1757563798/recording.har

@@ -0,0 +1,110 @@
+{
+  "log": {
+    "_recordingName": "Dashboards/Create a new dashboard with timeseries widget with custom_unit",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "38821fcaedaff1a1d6f2dc3c1a613e9e",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 712,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 555,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"description\":\"\",\"layout_type\":\"ordered\",\"notify_list\":[],\"reflow_type\":\"fixed\",\"template_variables\":[],\"title\":\"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1739811056\",\"widgets\":[{\"definition\":{\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\",\"number_format\":{\"unit\":{\"type\":\"canonical_unit\",\"unit_name\":\"fraction\"},\"unit_scale\":{\"type\":\"canonical_unit\",\"unit_name\":\"apdex\"}}}],\"queries\":[{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\"}],\"show_legend\":true,\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"timeseries\"},\"layout\":{\"height\":5,\"width\":12,\"x\":0,\"y\":0}}]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard"
+        },
+        "response": {
+          "bodySize": 1053,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1053,
+            "text": "{\"id\":\"a8v-698-pen\",\"title\":\"Test-Create_a_new_dashboard_with_timeseries_widget_with_custom_unit-1739811056\",\"description\":\"\",\"author_handle\":\"frog@datadoghq.com\",\"author_name\":\"frog\",\"layout_type\":\"ordered\",\"url\":\"/dashboard/a8v-698-pen/test-createanewdashboardwithtimeserieswidgetwithcustomunit-1739811056\",\"is_read_only\":false,\"template_variables\":[],\"widgets\":[{\"definition\":{\"legend_layout\":\"auto\",\"requests\":[{\"display_type\":\"line\",\"formulas\":[{\"formula\":\"query1\",\"number_format\":{\"unit\":{\"type\":\"canonical_unit\",\"unit_name\":\"fraction\"},\"unit_scale\":{\"type\":\"canonical_unit\",\"unit_name\":\"apdex\"}}}],\"queries\":[{\"data_source\":\"metrics\",\"name\":\"query1\",\"query\":\"avg:system.cpu.user{*}\"}],\"response_format\":\"timeseries\"}],\"show_legend\":true,\"time\":{},\"title\":\"\",\"title_align\":\"left\",\"title_size\":\"16\",\"type\":\"timeseries\"},\"layout\":{\"height\":5,\"width\":12,\"x\":0,\"y\":0},\"id\":6721814968677378}],\"notify_list\":[],\"created_at\":\"2025-02-17T16:50:57.183740+00:00\",\"modified_at\":\"2025-02-17T16:50:57.183740+00:00\",\"reflow_type\":\"fixed\",\"restricted_roles\":[]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 657,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-02-17T16:50:56.672Z",
+        "time": 613
+      },
+      {
+        "_id": "5ad97c5eb82dbeca915d3aedcc9af901",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 0,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 516,
+          "httpVersion": "HTTP/1.1",
+          "method": "DELETE",
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/dashboard/a8v-698-pen"
+        },
+        "response": {
+          "bodySize": 39,
+          "content": {
+            "mimeType": "application/json",
+            "size": 39,
+            "text": "{\"deleted_dashboard_id\":\"a8v-698-pen\"}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 655,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-02-17T16:50:57.291Z",
+        "time": 561
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v1/dashboards/CreateDashboard_3520534424.ts

@@ -0,0 +1,75 @@
+/**
+ * Create a new dashboard with timeseries widget with custom_unit
+ */
+
+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",
+    description: "",
+    widgets: [
+      {
+        definition: {
+          title: "",
+          titleSize: "16",
+          titleAlign: "left",
+          showLegend: true,
+          legendLayout: "auto",
+          time: {},
+          type: "timeseries",
+          requests: [
+            {
+              formulas: [
+                {
+                  formula: "query1",
+                  numberFormat: {
+                    unitScale: {
+                      type: "canonical_unit",
+                      unitName: "apdex",
+                    },
+                    unit: {
+                      type: "canonical_unit",
+                      unitName: "fraction",
+                    },
+                  },
+                },
+              ],
+              queries: [
+                {
+                  dataSource: "metrics",
+                  name: "query1",
+                  query: "avg:system.cpu.user{*}",
+                },
+              ],
+              responseFormat: "timeseries",
+              displayType: "line",
+            },
+          ],
+        },
+        layout: {
+          x: 0,
+          y: 0,
+          width: 12,
+          height: 5,
+        },
+      },
+    ],
+    templateVariables: [],
+    layoutType: "ordered",
+    notifyList: [],
+    reflowType: "fixed",
+  },
+};
+
+apiInstance
+  .createDashboard(params)
+  .then((data: v1.Dashboard) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v1/dashboards.feature

@@ -817,6 +817,18 @@ Feature: Dashboards
     And the response "widgets[0].definition.requests[0].display_type" is equal to "bars"
     And the response "widgets[0].definition.requests[0].q" is equal to "sum:trace.test.errors{env:prod,service:datadog-api-spec} by {resource_name}.as_count()"
 
+  @team:DataDog/dashboards-backend
+  Scenario: Create a new dashboard with timeseries widget with custom_unit
+    Given new "CreateDashboard" request
+    And body from file "dashboards_json_payload/timeseries_widget_with_custom_unit.json"
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "widgets[0].definition.type" is equal to "timeseries"
+    And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit_scale.type" is equal to "canonical_unit"
+    And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit_scale.unit_name" is equal to "apdex"
+    And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit.type" is equal to "canonical_unit"
+    And the response "widgets[0].definition.requests[0].formulas[0].number_format.unit.unit_name" is equal to "fraction"
+
   @team:DataDog/dashboards-backend
   Scenario: Create a new dashboard with toplist widget
     Given new "CreateDashboard" request

features/v1/dashboards_json_payload/timeseries_widget_with_custom_unit.json

@@ -0,0 +1,55 @@
+{
+  "title": "{{ unique }}",
+  "description": "",
+  "widgets": [
+    {
+      "definition": {
+        "title": "",
+        "title_size": "16",
+        "title_align": "left",
+        "show_legend": true,
+        "legend_layout": "auto",
+        "time": {},
+        "type": "timeseries",
+        "requests": [
+          {
+            "formulas": [
+              {
+                "formula": "query1",
+                "number_format": {
+                  "unit_scale": {
+                    "type": "canonical_unit",
+                    "unit_name": "apdex"
+                  },
+                  "unit": {
+                    "type": "canonical_unit",
+                    "unit_name": "fraction"
+                  }
+                }
+              }
+            ],
+            "queries": [
+              {
+                "data_source": "metrics",
+                "name": "query1",
+                "query": "avg:system.cpu.user{*}"
+              }
+            ],
+            "response_format": "timeseries",
+            "display_type": "line"
+          }
+        ]
+      },
+      "layout": {
+        "x": 0,
+        "y": 0,
+        "width": 12,
+        "height": 5
+      }
+    }
+  ],
+  "template_variables": [],
+  "layout_type": "ordered",
+  "notify_list": [],
+  "reflow_type": "fixed"
+}

packages/datadog-api-client-v1/index.ts

@@ -702,6 +702,12 @@ export { NoteWidgetDefinition } from "./models/NoteWidgetDefinition";
 export { NoteWidgetDefinitionType } from "./models/NoteWidgetDefinitionType";
 export { NotifyEndState } from "./models/NotifyEndState";
 export { NotifyEndType } from "./models/NotifyEndType";
+export { NumberFormatUnit } from "./models/NumberFormatUnit";
+export { NumberFormatUnitCanonical } from "./models/NumberFormatUnitCanonical";
+export { NumberFormatUnitCustom } from "./models/NumberFormatUnitCustom";
+export { NumberFormatUnitCustomType } from "./models/NumberFormatUnitCustomType";
+export { NumberFormatUnitScale } from "./models/NumberFormatUnitScale";
+export { NumberFormatUnitScaleType } from "./models/NumberFormatUnitScaleType";
 export { OnMissingDataOption } from "./models/OnMissingDataOption";
 export { Organization } from "./models/Organization";
 export { OrganizationBilling } from "./models/OrganizationBilling";
@@ -1213,6 +1219,7 @@ export { WidgetNewFixedSpanType } from "./models/WidgetNewFixedSpanType";
 export { WidgetNewLiveSpan } from "./models/WidgetNewLiveSpan";
 export { WidgetNewLiveSpanType } from "./models/WidgetNewLiveSpanType";
 export { WidgetNodeType } from "./models/WidgetNodeType";
+export { WidgetNumberFormat } from "./models/WidgetNumberFormat";
 export { WidgetOrderBy } from "./models/WidgetOrderBy";
 export { WidgetPalette } from "./models/WidgetPalette";
 export { WidgetRequestStyle } from "./models/WidgetRequestStyle";