Skip to content

Commit 73111f3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit b951844 of spec repo (#3746)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 629126b commit 73111f3

File tree

9 files changed

+330
-0
lines changed

9 files changed

+330
-0
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 76 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -24274,6 +24274,7 @@ components:
2427424274
- $ref: "#/components/schemas/ToplistWidgetDefinition"
2427524275
- $ref: "#/components/schemas/TopologyMapWidgetDefinition"
2427624276
- $ref: "#/components/schemas/TreeMapWidgetDefinition"
24277+
- $ref: "#/components/schemas/WildcardWidgetDefinition"
2427724278
WidgetDisplayType:
2427824279
description: Type of display to use for the request.
2427924280
enum:
@@ -25045,6 +25046,81 @@ components:
2504525046
x-enum-varnames:
2504625047
- TIMESERIES
2504725048
- TOPLIST
25049+
WildcardWidgetDefinition:
25050+
description: >-
25051+
Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations.
25052+
properties:
25053+
custom_links:
25054+
description: List of custom links.
25055+
items:
25056+
$ref: "#/components/schemas/WidgetCustomLink"
25057+
type: array
25058+
requests:
25059+
description: List of data requests for the wildcard widget.
25060+
example: [{"formulas": ["formula": "query1"], "queries": [{"aggregator": "avg", "data_source": "metrics", "name": "query1", "query": "avg:system.cpu.user{*} by {env}"}], "response_format": "scalar"}]
25061+
items:
25062+
$ref: "#/components/schemas/WildcardWidgetRequest"
25063+
type: array
25064+
specification:
25065+
$ref: "#/components/schemas/WildcardWidgetSpecification"
25066+
time:
25067+
$ref: "#/components/schemas/WidgetTime"
25068+
title:
25069+
description: Title of the widget.
25070+
type: string
25071+
title_align:
25072+
$ref: "#/components/schemas/WidgetTextAlign"
25073+
title_size:
25074+
description: Size of the title.
25075+
type: string
25076+
type:
25077+
$ref: "#/components/schemas/WildcardWidgetDefinitionType"
25078+
required:
25079+
- type
25080+
- requests
25081+
- specification
25082+
type: object
25083+
WildcardWidgetDefinitionType:
25084+
default: wildcard
25085+
description: Type of the wildcard widget.
25086+
enum:
25087+
- wildcard
25088+
example: wildcard
25089+
type: string
25090+
x-enum-varnames:
25091+
- WILDCARD
25092+
WildcardWidgetRequest:
25093+
description: >-
25094+
Request object for the wildcard widget. Each variant represents a distinct data-fetching pattern: scalar formulas, timeseries formulas, list streams, and histograms.
25095+
oneOf:
25096+
- $ref: "#/components/schemas/TreeMapWidgetRequest"
25097+
- $ref: "#/components/schemas/TimeseriesWidgetRequest"
25098+
- $ref: "#/components/schemas/ListStreamWidgetRequest"
25099+
- $ref: "#/components/schemas/DistributionWidgetRequest"
25100+
WildcardWidgetSpecification:
25101+
description: >-
25102+
Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.
25103+
properties:
25104+
contents:
25105+
description: The Vega or Vega-Lite JSON specification object.
25106+
example: {"$schema": "https://vega.github.io/schema/vega-lite/v5.json", "data": {"name": "table1"}, "description": "A simple bar chart", "encoding": {"x": {"field": "env", "sort": "-y", "type": "nominal"}, "y": {"field": "query1", "type": "quantitative"}}, "mark": "bar"}
25107+
type: object
25108+
type:
25109+
$ref: "#/components/schemas/WildcardWidgetSpecificationType"
25110+
required:
25111+
- type
25112+
- contents
25113+
type: object
25114+
WildcardWidgetSpecificationType:
25115+
description: Type of specification used by the wildcard widget.
25116+
enum:
25117+
- vega
25118+
- vega-lite
25119+
example: vega-lite
25120+
type: string
25121+
x-enum-varnames:
25122+
- VEGA
25123+
- VEGA_LITE
2504825124
securitySchemes:
2504925125
AuthZ:
2505025126
description: This API uses OAuth 2 with the implicit grant flow.

packages/datadog-api-client-v1/index.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1352,5 +1352,10 @@ export { WidgetTimeWindows } from "./models/WidgetTimeWindows";
13521352
export { WidgetVerticalAlign } from "./models/WidgetVerticalAlign";
13531353
export { WidgetViewMode } from "./models/WidgetViewMode";
13541354
export { WidgetVizType } from "./models/WidgetVizType";
1355+
export { WildcardWidgetDefinition } from "./models/WildcardWidgetDefinition";
1356+
export { WildcardWidgetDefinitionType } from "./models/WildcardWidgetDefinitionType";
1357+
export { WildcardWidgetRequest } from "./models/WildcardWidgetRequest";
1358+
export { WildcardWidgetSpecification } from "./models/WildcardWidgetSpecification";
1359+
export { WildcardWidgetSpecificationType } from "./models/WildcardWidgetSpecificationType";
13551360

13561361
export { ObjectSerializer } from "./models/ObjectSerializer";

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

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -689,6 +689,8 @@ import { WidgetNumberFormat } from "./WidgetNumberFormat";
689689
import { WidgetRequestStyle } from "./WidgetRequestStyle";
690690
import { WidgetSortBy } from "./WidgetSortBy";
691691
import { WidgetStyle } from "./WidgetStyle";
692+
import { WildcardWidgetDefinition } from "./WildcardWidgetDefinition";
693+
import { WildcardWidgetSpecification } from "./WildcardWidgetSpecification";
692694
import {
693695
dateFromRFC3339String,
694696
dateToRFC3339String,
@@ -1872,6 +1874,8 @@ const enumsMap: { [key: string]: any[] } = {
18721874
WidgetVerticalAlign: ["center", "top", "bottom"],
18731875
WidgetViewMode: ["overall", "component", "both"],
18741876
WidgetVizType: ["timeseries", "toplist"],
1877+
WildcardWidgetDefinitionType: ["wildcard"],
1878+
WildcardWidgetSpecificationType: ["vega", "vega-lite"],
18751879
};
18761880

18771881
const typeMap: { [index: string]: any } = {
@@ -2629,6 +2633,8 @@ const typeMap: { [index: string]: any } = {
26292633
WidgetRequestStyle: WidgetRequestStyle,
26302634
WidgetSortBy: WidgetSortBy,
26312635
WidgetStyle: WidgetStyle,
2636+
WildcardWidgetDefinition: WildcardWidgetDefinition,
2637+
WildcardWidgetSpecification: WildcardWidgetSpecification,
26322638
};
26332639

26342640
const oneOfMap: { [index: string]: string[] } = {
@@ -2826,13 +2832,20 @@ const oneOfMap: { [index: string]: string[] } = {
28262832
"ToplistWidgetDefinition",
28272833
"TopologyMapWidgetDefinition",
28282834
"TreeMapWidgetDefinition",
2835+
"WildcardWidgetDefinition",
28292836
],
28302837
WidgetSortOrderBy: ["WidgetFormulaSort", "WidgetGroupSort"],
28312838
WidgetTime: [
28322839
"WidgetLegacyLiveSpan",
28332840
"WidgetNewLiveSpan",
28342841
"WidgetNewFixedSpan",
28352842
],
2843+
WildcardWidgetRequest: [
2844+
"TreeMapWidgetRequest",
2845+
"TimeseriesWidgetRequest",
2846+
"ListStreamWidgetRequest",
2847+
"DistributionWidgetRequest",
2848+
],
28362849
};
28372850

28382851
export class ObjectSerializer {

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

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,7 @@ import { TimeseriesWidgetDefinition } from "./TimeseriesWidgetDefinition";
3939
import { ToplistWidgetDefinition } from "./ToplistWidgetDefinition";
4040
import { TopologyMapWidgetDefinition } from "./TopologyMapWidgetDefinition";
4141
import { TreeMapWidgetDefinition } from "./TreeMapWidgetDefinition";
42+
import { WildcardWidgetDefinition } from "./WildcardWidgetDefinition";
4243

4344
import { UnparsedObject } from "../../datadog-api-client-common/util";
4445

@@ -83,4 +84,5 @@ export type WidgetDefinition =
8384
| ToplistWidgetDefinition
8485
| TopologyMapWidgetDefinition
8586
| TreeMapWidgetDefinition
87+
| WildcardWidgetDefinition
8688
| UnparsedObject;
Lines changed: 117 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,117 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { WidgetCustomLink } from "./WidgetCustomLink";
7+
import { WidgetTextAlign } from "./WidgetTextAlign";
8+
import { WidgetTime } from "./WidgetTime";
9+
import { WildcardWidgetDefinitionType } from "./WildcardWidgetDefinitionType";
10+
import { WildcardWidgetRequest } from "./WildcardWidgetRequest";
11+
import { WildcardWidgetSpecification } from "./WildcardWidgetSpecification";
12+
13+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
14+
15+
/**
16+
* Custom visualization widget using Vega or Vega-Lite specifications. Combines standard Datadog data requests with a Vega or Vega-Lite JSON specification for flexible, custom visualizations.
17+
*/
18+
export class WildcardWidgetDefinition {
19+
/**
20+
* List of custom links.
21+
*/
22+
"customLinks"?: Array<WidgetCustomLink>;
23+
/**
24+
* List of data requests for the wildcard widget.
25+
*/
26+
"requests": Array<WildcardWidgetRequest>;
27+
/**
28+
* Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.
29+
*/
30+
"specification": WildcardWidgetSpecification;
31+
/**
32+
* Time setting for the widget.
33+
*/
34+
"time"?: WidgetTime;
35+
/**
36+
* Title of the widget.
37+
*/
38+
"title"?: string;
39+
/**
40+
* How to align the text on the widget.
41+
*/
42+
"titleAlign"?: WidgetTextAlign;
43+
/**
44+
* Size of the title.
45+
*/
46+
"titleSize"?: string;
47+
/**
48+
* Type of the wildcard widget.
49+
*/
50+
"type": WildcardWidgetDefinitionType;
51+
52+
/**
53+
* A container for additional, undeclared properties.
54+
* This is a holder for any undeclared properties as specified with
55+
* the 'additionalProperties' keyword in the OAS document.
56+
*/
57+
"additionalProperties"?: { [key: string]: any };
58+
59+
/**
60+
* @ignore
61+
*/
62+
"_unparsed"?: boolean;
63+
64+
/**
65+
* @ignore
66+
*/
67+
static readonly attributeTypeMap: AttributeTypeMap = {
68+
customLinks: {
69+
baseName: "custom_links",
70+
type: "Array<WidgetCustomLink>",
71+
},
72+
requests: {
73+
baseName: "requests",
74+
type: "Array<WildcardWidgetRequest>",
75+
required: true,
76+
},
77+
specification: {
78+
baseName: "specification",
79+
type: "WildcardWidgetSpecification",
80+
required: true,
81+
},
82+
time: {
83+
baseName: "time",
84+
type: "WidgetTime",
85+
},
86+
title: {
87+
baseName: "title",
88+
type: "string",
89+
},
90+
titleAlign: {
91+
baseName: "title_align",
92+
type: "WidgetTextAlign",
93+
},
94+
titleSize: {
95+
baseName: "title_size",
96+
type: "string",
97+
},
98+
type: {
99+
baseName: "type",
100+
type: "WildcardWidgetDefinitionType",
101+
required: true,
102+
},
103+
additionalProperties: {
104+
baseName: "additionalProperties",
105+
type: "{ [key: string]: any; }",
106+
},
107+
};
108+
109+
/**
110+
* @ignore
111+
*/
112+
static getAttributeTypeMap(): AttributeTypeMap {
113+
return WildcardWidgetDefinition.attributeTypeMap;
114+
}
115+
116+
public constructor() {}
117+
}
Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
7+
import { UnparsedObject } from "../../datadog-api-client-common/util";
8+
9+
/**
10+
* Type of the wildcard widget.
11+
*/
12+
13+
export type WildcardWidgetDefinitionType = typeof WILDCARD | UnparsedObject;
14+
export const WILDCARD = "wildcard";
Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { DistributionWidgetRequest } from "./DistributionWidgetRequest";
7+
import { ListStreamWidgetRequest } from "./ListStreamWidgetRequest";
8+
import { TimeseriesWidgetRequest } from "./TimeseriesWidgetRequest";
9+
import { TreeMapWidgetRequest } from "./TreeMapWidgetRequest";
10+
11+
import { UnparsedObject } from "../../datadog-api-client-common/util";
12+
13+
/**
14+
* Request object for the wildcard widget. Each variant represents a distinct data-fetching pattern: scalar formulas, timeseries formulas, list streams, and histograms.
15+
*/
16+
17+
export type WildcardWidgetRequest =
18+
| TreeMapWidgetRequest
19+
| TimeseriesWidgetRequest
20+
| ListStreamWidgetRequest
21+
| DistributionWidgetRequest
22+
| UnparsedObject;
Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,63 @@
1+
/**
2+
* Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
3+
* This product includes software developed at Datadog (https://www.datadoghq.com/).
4+
* Copyright 2020-Present Datadog, Inc.
5+
*/
6+
import { WildcardWidgetSpecificationType } from "./WildcardWidgetSpecificationType";
7+
8+
import { AttributeTypeMap } from "../../datadog-api-client-common/util";
9+
10+
/**
11+
* Vega or Vega-Lite specification for custom visualization rendering. See https://vega.github.io/vega-lite/ for the full grammar reference.
12+
*/
13+
export class WildcardWidgetSpecification {
14+
/**
15+
* The Vega or Vega-Lite JSON specification object.
16+
*/
17+
"contents": any;
18+
/**
19+
* Type of specification used by the wildcard widget.
20+
*/
21+
"type": WildcardWidgetSpecificationType;
22+
23+
/**
24+
* A container for additional, undeclared properties.
25+
* This is a holder for any undeclared properties as specified with
26+
* the 'additionalProperties' keyword in the OAS document.
27+
*/
28+
"additionalProperties"?: { [key: string]: any };
29+
30+
/**
31+
* @ignore
32+
*/
33+
"_unparsed"?: boolean;
34+
35+
/**
36+
* @ignore
37+
*/
38+
static readonly attributeTypeMap: AttributeTypeMap = {
39+
contents: {
40+
baseName: "contents",
41+
type: "any",
42+
required: true,
43+
},
44+
type: {
45+
baseName: "type",
46+
type: "WildcardWidgetSpecificationType",
47+
required: true,
48+
},
49+
additionalProperties: {
50+
baseName: "additionalProperties",
51+
type: "{ [key: string]: any; }",
52+
},
53+
};
54+
55+
/**
56+
* @ignore
57+
*/
58+
static getAttributeTypeMap(): AttributeTypeMap {
59+
return WildcardWidgetSpecification.attributeTypeMap;
60+
}
61+
62+
public constructor() {}
63+
}

0 commit comments

Comments
 (0)