From 42a975f1e0f8e50f2b5c6ee329b629bfadb44392 Mon Sep 17 00:00:00 2001 From: "api-clients-generation-pipeline[bot]" <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Date: Wed, 14 Jun 2023 20:33:16 +0000 Subject: [PATCH] Update dashboard widget axis field descriptions (#1507) Co-authored-by: ci.datadog-api-spec --- .apigentools-info | 8 ++++---- .generator/schemas/v1/openapi.yaml | 15 ++++++++------- src/datadog_api_client/v1/model/widget_axis.py | 10 +++++----- 3 files changed, 17 insertions(+), 16 deletions(-) diff --git a/.apigentools-info b/.apigentools-info index d8363c41ed..10c1307a13 100644 --- a/.apigentools-info +++ b/.apigentools-info @@ -4,13 +4,13 @@ "spec_versions": { "v1": { "apigentools_version": "1.6.4", - "regenerated": "2023-06-14 14:30:34.005418", - "spec_repo_commit": "23362011" + "regenerated": "2023-06-14 19:36:43.904832", + "spec_repo_commit": "aafb3db6" }, "v2": { "apigentools_version": "1.6.4", - "regenerated": "2023-06-14 14:30:34.017315", - "spec_repo_commit": "23362011" + "regenerated": "2023-06-14 19:36:43.917759", + "spec_repo_commit": "aafb3db6" } } } \ No newline at end of file diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml index dde167c397..b224ab9b1a 100644 --- 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/src/datadog_api_client/v1/model/widget_axis.py b/src/datadog_api_client/v1/model/widget_axis.py index 49bb7e1f96..4dd725dfbf 100644 --- a/src/datadog_api_client/v1/model/widget_axis.py +++ b/src/datadog_api_client/v1/model/widget_axis.py @@ -44,19 +44,19 @@ def __init__( """ Axis controls for the widget. - :param include_zero: True includes zero. + :param include_zero: Set to ``true`` to include zero. :type include_zero: bool, optional - :param label: The label of the axis to display on the graph. + :param label: The label of the axis to display on the graph. Only usable on Scatterplot Widgets. :type label: str, optional - :param max: Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior. + :param max: Specifies maximum numeric value to show on the axis. Defaults to ``auto``. :type max: str, optional - :param min: Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior. + :param min: Specifies minimum numeric value to show on the axis. Defaults to ``auto``. :type min: str, optional - :param scale: Specifies the scale type. Possible values are ``linear`` , ``log`` , ``sqrt`` , ``pow##`` (for example ``pow2`` , ``pow0.5`` etc.). + :param scale: Specifies the scale type. Possible values are ``linear`` , ``log`` , ``sqrt`` , and ``pow##`` (for example ``pow2`` or ``pow0.5`` ). :type scale: str, optional """ if include_zero is not unset: