Skip to content

Commit 890d48e

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
api-clients-generation-pipeline[bot]
and
ci.datadog-api-spec
authored
Mark legacy non-FnF query fields and WidgetEvent as deprecated in dashboard spec and update Distribution docs (#3746)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0200aa3 commit 890d48e

16 files changed

Lines changed: 305 additions & 32 deletions

‎.generator/schemas/v1/openapi.yaml‎

Lines changed: 235 additions & 16 deletions
Large diffs are not rendered by default.

‎api/datadogV1/model_bar_chart_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,8 @@ type BarChartWidgetRequest struct {
2828
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
2929
// The log query.
3030
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
31-
// Widget query.
31+
// Widget query. Deprecated - Use `queries` and `formulas` instead.
32+
// Deprecated
3233
Q *string `json:"q,omitempty"`
3334
// List of queries that can be returned directly or used in formulas.
3435
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -317,6 +318,7 @@ func (o *BarChartWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
317318
}
318319

319320
// GetQ returns the Q field value if set, zero value otherwise.
321+
// Deprecated
320322
func (o *BarChartWidgetRequest) GetQ() string {
321323
if o == nil || o.Q == nil {
322324
var ret string
@@ -327,6 +329,7 @@ func (o *BarChartWidgetRequest) GetQ() string {
327329

328330
// GetQOk returns a tuple with the Q field value if set, nil otherwise
329331
// and a boolean to check if the value has been set.
332+
// Deprecated
330333
func (o *BarChartWidgetRequest) GetQOk() (*string, bool) {
331334
if o == nil || o.Q == nil {
332335
return nil, false
@@ -340,6 +343,7 @@ func (o *BarChartWidgetRequest) HasQ() bool {
340343
}
341344

342345
// SetQ gets a reference to the given string and assigns it to the Q field.
346+
// Deprecated
343347
func (o *BarChartWidgetRequest) SetQ(v string) {
344348
o.Q = &v
345349
}

‎api/datadogV1/model_change_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,8 @@ type ChangeWidgetRequest struct {
3434
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
3535
// The log query.
3636
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
37-
// Query definition.
37+
// Query definition. Deprecated - Use `queries` and `formulas` instead.
38+
// Deprecated
3839
Q *string `json:"q,omitempty"`
3940
// List of queries that can be returned directly or used in formulas.
4041
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -405,6 +406,7 @@ func (o *ChangeWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
405406
}
406407

407408
// GetQ returns the Q field value if set, zero value otherwise.
409+
// Deprecated
408410
func (o *ChangeWidgetRequest) GetQ() string {
409411
if o == nil || o.Q == nil {
410412
var ret string
@@ -415,6 +417,7 @@ func (o *ChangeWidgetRequest) GetQ() string {
415417

416418
// GetQOk returns a tuple with the Q field value if set, nil otherwise
417419
// and a boolean to check if the value has been set.
420+
// Deprecated
418421
func (o *ChangeWidgetRequest) GetQOk() (*string, bool) {
419422
if o == nil || o.Q == nil {
420423
return nil, false
@@ -428,6 +431,7 @@ func (o *ChangeWidgetRequest) HasQ() bool {
428431
}
429432

430433
// SetQ gets a reference to the given string and assigns it to the Q field.
434+
// Deprecated
431435
func (o *ChangeWidgetRequest) SetQ(v string) {
432436
o.Q = &v
433437
}

‎api/datadogV1/model_distribution_widget_request.go‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,13 +26,14 @@ type DistributionWidgetRequest struct {
2626
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
2727
// The log query.
2828
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
29-
// Widget query.
29+
// Widget query. Deprecated - Use `queries` and `formulas` instead.
30+
// Deprecated
3031
Q *string `json:"q,omitempty"`
3132
// List of queries that can be returned directly or used in formulas.
3233
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
3334
// Query definition for Distribution Widget Histogram Request
3435
Query *DistributionWidgetHistogramRequestQuery `json:"query,omitempty"`
35-
// Request type for the histogram request.
36+
// Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
3637
RequestType *WidgetHistogramRequestType `json:"request_type,omitempty"`
3738
// Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
3839
ResponseFormat *FormulaAndFunctionResponseFormat `json:"response_format,omitempty"`
@@ -289,6 +290,7 @@ func (o *DistributionWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition)
289290
}
290291

291292
// GetQ returns the Q field value if set, zero value otherwise.
293+
// Deprecated
292294
func (o *DistributionWidgetRequest) GetQ() string {
293295
if o == nil || o.Q == nil {
294296
var ret string
@@ -299,6 +301,7 @@ func (o *DistributionWidgetRequest) GetQ() string {
299301

300302
// GetQOk returns a tuple with the Q field value if set, nil otherwise
301303
// and a boolean to check if the value has been set.
304+
// Deprecated
302305
func (o *DistributionWidgetRequest) GetQOk() (*string, bool) {
303306
if o == nil || o.Q == nil {
304307
return nil, false
@@ -312,6 +315,7 @@ func (o *DistributionWidgetRequest) HasQ() bool {
312315
}
313316

314317
// SetQ gets a reference to the given string and assigns it to the Q field.
318+
// Deprecated
315319
func (o *DistributionWidgetRequest) SetQ(v string) {
316320
o.Q = &v
317321
}

‎api/datadogV1/model_geomap_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,8 @@ type GeomapWidgetRequest struct {
1818
Formulas []WidgetFormula `json:"formulas,omitempty"`
1919
// The log query.
2020
LogQuery *LogQueryDefinition `json:"log_query,omitempty"`
21-
// The widget metrics query.
21+
// The widget metrics query. Deprecated - Use `queries` and `formulas` instead.
22+
// Deprecated
2223
Q *string `json:"q,omitempty"`
2324
// List of queries that can be returned directly or used in formulas.
2425
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -171,6 +172,7 @@ func (o *GeomapWidgetRequest) SetLogQuery(v LogQueryDefinition) {
171172
}
172173

173174
// GetQ returns the Q field value if set, zero value otherwise.
175+
// Deprecated
174176
func (o *GeomapWidgetRequest) GetQ() string {
175177
if o == nil || o.Q == nil {
176178
var ret string
@@ -181,6 +183,7 @@ func (o *GeomapWidgetRequest) GetQ() string {
181183

182184
// GetQOk returns a tuple with the Q field value if set, nil otherwise
183185
// and a boolean to check if the value has been set.
186+
// Deprecated
184187
func (o *GeomapWidgetRequest) GetQOk() (*string, bool) {
185188
if o == nil || o.Q == nil {
186189
return nil, false
@@ -194,6 +197,7 @@ func (o *GeomapWidgetRequest) HasQ() bool {
194197
}
195198

196199
// SetQ gets a reference to the given string and assigns it to the Q field.
200+
// Deprecated
197201
func (o *GeomapWidgetRequest) SetQ(v string) {
198202
o.Q = &v
199203
}

‎api/datadogV1/model_heat_map_widget_definition.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@ import (
1414
type HeatMapWidgetDefinition struct {
1515
// List of custom links.
1616
CustomLinks []WidgetCustomLink `json:"custom_links,omitempty"`
17-
// List of widget events.
17+
// List of widget events. Deprecated - Use `overlay` request type instead.
18+
// Deprecated
1819
Events []WidgetEvent `json:"events,omitempty"`
1920
// Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
2021
LegendSize *string `json:"legend_size,omitempty"`
@@ -93,6 +94,7 @@ func (o *HeatMapWidgetDefinition) SetCustomLinks(v []WidgetCustomLink) {
9394
}
9495

9596
// GetEvents returns the Events field value if set, zero value otherwise.
97+
// Deprecated
9698
func (o *HeatMapWidgetDefinition) GetEvents() []WidgetEvent {
9799
if o == nil || o.Events == nil {
98100
var ret []WidgetEvent
@@ -103,6 +105,7 @@ func (o *HeatMapWidgetDefinition) GetEvents() []WidgetEvent {
103105

104106
// GetEventsOk returns a tuple with the Events field value if set, nil otherwise
105107
// and a boolean to check if the value has been set.
108+
// Deprecated
106109
func (o *HeatMapWidgetDefinition) GetEventsOk() (*[]WidgetEvent, bool) {
107110
if o == nil || o.Events == nil {
108111
return nil, false
@@ -116,6 +119,7 @@ func (o *HeatMapWidgetDefinition) HasEvents() bool {
116119
}
117120

118121
// SetEvents gets a reference to the given []WidgetEvent and assigns it to the Events field.
122+
// Deprecated
119123
func (o *HeatMapWidgetDefinition) SetEvents(v []WidgetEvent) {
120124
o.Events = v
121125
}

‎api/datadogV1/model_heat_map_widget_request.go‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -24,13 +24,14 @@ type HeatMapWidgetRequest struct {
2424
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
2525
// The log query.
2626
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
27-
// Widget query.
27+
// Widget query. Deprecated - Use `queries` and `formulas` instead.
28+
// Deprecated
2829
Q *string `json:"q,omitempty"`
2930
// List of queries that can be returned directly or used in formulas.
3031
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
3132
// A formula and functions metrics query.
3233
Query *FormulaAndFunctionMetricQueryDefinition `json:"query,omitempty"`
33-
// Request type for the histogram request.
34+
// Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
3435
RequestType *WidgetHistogramRequestType `json:"request_type,omitempty"`
3536
// Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
3637
ResponseFormat *FormulaAndFunctionResponseFormat `json:"response_format,omitempty"`
@@ -259,6 +260,7 @@ func (o *HeatMapWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
259260
}
260261

261262
// GetQ returns the Q field value if set, zero value otherwise.
263+
// Deprecated
262264
func (o *HeatMapWidgetRequest) GetQ() string {
263265
if o == nil || o.Q == nil {
264266
var ret string
@@ -269,6 +271,7 @@ func (o *HeatMapWidgetRequest) GetQ() string {
269271

270272
// GetQOk returns a tuple with the Q field value if set, nil otherwise
271273
// and a boolean to check if the value has been set.
274+
// Deprecated
272275
func (o *HeatMapWidgetRequest) GetQOk() (*string, bool) {
273276
if o == nil || o.Q == nil {
274277
return nil, false
@@ -282,6 +285,7 @@ func (o *HeatMapWidgetRequest) HasQ() bool {
282285
}
283286

284287
// SetQ gets a reference to the given string and assigns it to the Q field.
288+
// Deprecated
285289
func (o *HeatMapWidgetRequest) SetQ(v string) {
286290
o.Q = &v
287291
}

‎api/datadogV1/model_query_value_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,8 @@ type QueryValueWidgetRequest struct {
3030
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
3131
// The log query.
3232
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
33-
// TODO.
33+
// Widget query. Deprecated - Use `queries` and `formulas` instead.
34+
// Deprecated
3435
Q *string `json:"q,omitempty"`
3536
// List of queries that can be returned directly or used in formulas.
3637
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -343,6 +344,7 @@ func (o *QueryValueWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
343344
}
344345

345346
// GetQ returns the Q field value if set, zero value otherwise.
347+
// Deprecated
346348
func (o *QueryValueWidgetRequest) GetQ() string {
347349
if o == nil || o.Q == nil {
348350
var ret string
@@ -353,6 +355,7 @@ func (o *QueryValueWidgetRequest) GetQ() string {
353355

354356
// GetQOk returns a tuple with the Q field value if set, nil otherwise
355357
// and a boolean to check if the value has been set.
358+
// Deprecated
356359
func (o *QueryValueWidgetRequest) GetQOk() (*string, bool) {
357360
if o == nil || o.Q == nil {
358361
return nil, false
@@ -366,6 +369,7 @@ func (o *QueryValueWidgetRequest) HasQ() bool {
366369
}
367370

368371
// SetQ gets a reference to the given string and assigns it to the Q field.
372+
// Deprecated
369373
func (o *QueryValueWidgetRequest) SetQ(v string) {
370374
o.Q = &v
371375
}

‎api/datadogV1/model_sunburst_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,8 @@ type SunburstWidgetRequest struct {
2626
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
2727
// The log query.
2828
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
29-
// Widget query.
29+
// Widget query. Deprecated - Use `queries` and `formulas` instead.
30+
// Deprecated
3031
Q *string `json:"q,omitempty"`
3132
// List of queries that can be returned directly or used in formulas.
3233
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -285,6 +286,7 @@ func (o *SunburstWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
285286
}
286287

287288
// GetQ returns the Q field value if set, zero value otherwise.
289+
// Deprecated
288290
func (o *SunburstWidgetRequest) GetQ() string {
289291
if o == nil || o.Q == nil {
290292
var ret string
@@ -295,6 +297,7 @@ func (o *SunburstWidgetRequest) GetQ() string {
295297

296298
// GetQOk returns a tuple with the Q field value if set, nil otherwise
297299
// and a boolean to check if the value has been set.
300+
// Deprecated
298301
func (o *SunburstWidgetRequest) GetQOk() (*string, bool) {
299302
if o == nil || o.Q == nil {
300303
return nil, false
@@ -308,6 +311,7 @@ func (o *SunburstWidgetRequest) HasQ() bool {
308311
}
309312

310313
// SetQ gets a reference to the given string and assigns it to the Q field.
314+
// Deprecated
311315
func (o *SunburstWidgetRequest) SetQ(v string) {
312316
o.Q = &v
313317
}

‎api/datadogV1/model_table_widget_request.go‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ type TableWidgetRequest struct {
3838
ProcessQuery *ProcessQueryDefinition `json:"process_query,omitempty"`
3939
// The log query.
4040
ProfileMetricsQuery *LogQueryDefinition `json:"profile_metrics_query,omitempty"`
41-
// Query definition.
41+
// Query definition. Deprecated - Use `queries` and `formulas` instead.
42+
// Deprecated
4243
Q *string `json:"q,omitempty"`
4344
// List of queries that can be returned directly or used in formulas.
4445
Queries []FormulaAndFunctionQueryDefinition `json:"queries,omitempty"`
@@ -467,6 +468,7 @@ func (o *TableWidgetRequest) SetProfileMetricsQuery(v LogQueryDefinition) {
467468
}
468469

469470
// GetQ returns the Q field value if set, zero value otherwise.
471+
// Deprecated
470472
func (o *TableWidgetRequest) GetQ() string {
471473
if o == nil || o.Q == nil {
472474
var ret string
@@ -477,6 +479,7 @@ func (o *TableWidgetRequest) GetQ() string {
477479

478480
// GetQOk returns a tuple with the Q field value if set, nil otherwise
479481
// and a boolean to check if the value has been set.
482+
// Deprecated
480483
func (o *TableWidgetRequest) GetQOk() (*string, bool) {
481484
if o == nil || o.Q == nil {
482485
return nil, false
@@ -490,6 +493,7 @@ func (o *TableWidgetRequest) HasQ() bool {
490493
}
491494

492495
// SetQ gets a reference to the given string and assigns it to the Q field.
496+
// Deprecated
493497
func (o *TableWidgetRequest) SetQ(v string) {
494498
o.Q = &v
495499
}

0 commit comments

Comments
 (0)