Update dashboard widget axis field descriptions (#1174)

Co-authored-by: ci.datadog-api-spec <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
DataDog · Jun 14, 2023 · 5a00d58 · 5a00d58
1 parent b735408
commit 5a00d58
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 16 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-14 14:30:37.426570",
-            "spec_repo_commit": "23362011"
+            "regenerated": "2023-06-14 19:36:50.047106",
+            "spec_repo_commit": "aafb3db6"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-06-14 14:30:37.440643",
-            "spec_repo_commit": "23362011"
+            "regenerated": "2023-06-14 19:36:50.066398",
+            "spec_repo_commit": "aafb3db6"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -19146,25 +19146,26 @@ components:
       description: Axis controls for the widget.
       properties:
         include_zero:
-          description: True includes zero.
+          description: Set to `true` to include zero.
           type: boolean
         label:
-          description: The label of the axis to display on the graph.
+          description: The label of the axis to display on the graph. Only usable
+            on Scatterplot Widgets.
           type: string
         max:
           default: auto
-          description: Specifies the maximum value to show on the y-axis. It takes
-            a number, or auto for default behavior.
+          description: Specifies maximum numeric value to show on the axis. Defaults
+            to `auto`.
           type: string
         min:
           default: auto
-          description: Specifies minimum value to show on the y-axis. It takes a number,
-            or auto for default behavior.
+          description: Specifies minimum numeric value to show on the axis. Defaults
+            to `auto`.
           type: string
         scale:
           default: linear
           description: Specifies the scale type. Possible values are `linear`, `log`,
-            `sqrt`, `pow##` (for example `pow2`, `pow0.5` etc.).
+            `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
           type: string
       type: object
     WidgetChangeType:

diff --git a/packages/datadog-api-client-v1/models/WidgetAxis.ts b/packages/datadog-api-client-v1/models/WidgetAxis.ts
@@ -11,23 +11,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
  */
 export class WidgetAxis {
   /**
-   * True includes zero.
+   * Set to `true` to include zero.
    */
   "includeZero"?: boolean;
   /**
-   * The label of the axis to display on the graph.
+   * The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
    */
   "label"?: string;
   /**
-   * Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
+   * Specifies maximum numeric value to show on the axis. Defaults to `auto`.
    */
   "max"?: string;
   /**
-   * Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
+   * Specifies minimum numeric value to show on the axis. Defaults to `auto`.
    */
   "min"?: string;
   /**
-   * Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (for example `pow2`, `pow0.5` etc.).
+   * Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
    */
   "scale"?: string;