Skip to content

Update dashboard widget axis field descriptions #1507

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 14, 2023
Merged

Update dashboard widget axis field descriptions #1507

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions .apigentools-info
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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"
}
}
}
15 changes: 8 additions & 7 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
10 changes: 5 additions & 5 deletions src/datadog_api_client/v1/model/widget_axis.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down