Skip to content

Commit 42a975f

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update dashboard widget axis field descriptions (#1507)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent b84918a commit 42a975f

File tree

3 files changed

+17
-16
lines changed

3 files changed

+17
-16
lines changed

.apigentools-info

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,13 @@
44
"spec_versions": {
55
"v1": {
66
"apigentools_version": "1.6.4",
7-
"regenerated": "2023-06-14 14:30:34.005418",
8-
"spec_repo_commit": "23362011"
7+
"regenerated": "2023-06-14 19:36:43.904832",
8+
"spec_repo_commit": "aafb3db6"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-06-14 14:30:34.017315",
13-
"spec_repo_commit": "23362011"
12+
"regenerated": "2023-06-14 19:36:43.917759",
13+
"spec_repo_commit": "aafb3db6"
1414
}
1515
}
1616
}

.generator/schemas/v1/openapi.yaml

Lines changed: 8 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -19146,25 +19146,26 @@ components:
1914619146
description: Axis controls for the widget.
1914719147
properties:
1914819148
include_zero:
19149-
description: True includes zero.
19149+
description: Set to `true` to include zero.
1915019150
type: boolean
1915119151
label:
19152-
description: The label of the axis to display on the graph.
19152+
description: The label of the axis to display on the graph. Only usable
19153+
on Scatterplot Widgets.
1915319154
type: string
1915419155
max:
1915519156
default: auto
19156-
description: Specifies the maximum value to show on the y-axis. It takes
19157-
a number, or auto for default behavior.
19157+
description: Specifies maximum numeric value to show on the axis. Defaults
19158+
to `auto`.
1915819159
type: string
1915919160
min:
1916019161
default: auto
19161-
description: Specifies minimum value to show on the y-axis. It takes a number,
19162-
or auto for default behavior.
19162+
description: Specifies minimum numeric value to show on the axis. Defaults
19163+
to `auto`.
1916319164
type: string
1916419165
scale:
1916519166
default: linear
1916619167
description: Specifies the scale type. Possible values are `linear`, `log`,
19167-
`sqrt`, `pow##` (for example `pow2`, `pow0.5` etc.).
19168+
`sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
1916819169
type: string
1916919170
type: object
1917019171
WidgetChangeType:

src/datadog_api_client/v1/model/widget_axis.py

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44,19 +44,19 @@ def __init__(
4444
"""
4545
Axis controls for the widget.
4646
47-
:param include_zero: True includes zero.
47+
:param include_zero: Set to ``true`` to include zero.
4848
:type include_zero: bool, optional
4949
50-
:param label: The label of the axis to display on the graph.
50+
:param label: The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
5151
:type label: str, optional
5252
53-
:param max: Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
53+
:param max: Specifies maximum numeric value to show on the axis. Defaults to ``auto``.
5454
:type max: str, optional
5555
56-
:param min: Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
56+
:param min: Specifies minimum numeric value to show on the axis. Defaults to ``auto``.
5757
:type min: str, optional
5858
59-
:param scale: Specifies the scale type. Possible values are ``linear`` , ``log`` , ``sqrt`` , ``pow##`` (for example ``pow2`` , ``pow0.5`` etc.).
59+
:param scale: Specifies the scale type. Possible values are ``linear`` , ``log`` , ``sqrt`` , and ``pow##`` (for example ``pow2`` or ``pow0.5`` ).
6060
:type scale: str, optional
6161
"""
6262
if include_zero is not unset:

0 commit comments

Comments
 (0)