Skip to content

Commit 5a00d58

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
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>
1 parent b735408 commit 5a00d58

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:37.426570",
8-
"spec_repo_commit": "23362011"
7+
"regenerated": "2023-06-14 19:36:50.047106",
8+
"spec_repo_commit": "aafb3db6"
99
},
1010
"v2": {
1111
"apigentools_version": "1.6.4",
12-
"regenerated": "2023-06-14 14:30:37.440643",
13-
"spec_repo_commit": "23362011"
12+
"regenerated": "2023-06-14 19:36:50.066398",
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:

packages/datadog-api-client-v1/models/WidgetAxis.ts

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -11,23 +11,23 @@ import { AttributeTypeMap } from "../../datadog-api-client-common/util";
1111
*/
1212
export class WidgetAxis {
1313
/**
14-
* True includes zero.
14+
* Set to `true` to include zero.
1515
*/
1616
"includeZero"?: boolean;
1717
/**
18-
* The label of the axis to display on the graph.
18+
* The label of the axis to display on the graph. Only usable on Scatterplot Widgets.
1919
*/
2020
"label"?: string;
2121
/**
22-
* Specifies the maximum value to show on the y-axis. It takes a number, or auto for default behavior.
22+
* Specifies maximum numeric value to show on the axis. Defaults to `auto`.
2323
*/
2424
"max"?: string;
2525
/**
26-
* Specifies minimum value to show on the y-axis. It takes a number, or auto for default behavior.
26+
* Specifies minimum numeric value to show on the axis. Defaults to `auto`.
2727
*/
2828
"min"?: string;
2929
/**
30-
* Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, `pow##` (for example `pow2`, `pow0.5` etc.).
30+
* Specifies the scale type. Possible values are `linear`, `log`, `sqrt`, and `pow##` (for example `pow2` or `pow0.5`).
3131
*/
3232
"scale"?: string;
3333

0 commit comments

Comments
 (0)