Skip to content

Mark legacy non-FnF query fields and WidgetEvent as deprecated in dashboard spec + update Distribuition docs #3045

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Mark legacy non-FnF query fields and WidgetEvent as deprecated in dashboard spec + update Distribuition docs #3045

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
251 changes: 235 additions & 16 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/bar_chart_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class BarChartWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/change_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,7 +57,7 @@ class ChangeWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Query definition.
# Query definition. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
4 changes: 2 additions & 2 deletions lib/datadog_api_client/v1/models/distribution_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class DistributionWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand All @@ -54,7 +54,7 @@ class DistributionWidgetRequest
# Query definition for Distribution Widget Histogram Request
attr_accessor :query

# Request type for the histogram request.
# Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
attr_accessor :request_type

# Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/geomap_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ class GeomapWidgetRequest
# The log query.
attr_accessor :log_query

# The widget metrics query.
# The widget metrics query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/heat_map_widget_definition.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class HeatMapWidgetDefinition
# List of custom links.
attr_accessor :custom_links

# List of widget events.
# List of widget events. Deprecated - Use `overlay` request type instead.
attr_accessor :events

# Available legend sizes for a widget. Should be one of "0", "2", "4", "8", "16", or "auto".
Expand Down
4 changes: 2 additions & 2 deletions lib/datadog_api_client/v1/models/heat_map_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ class HeatMapWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand All @@ -51,7 +51,7 @@ class HeatMapWidgetRequest
# A formula and functions metrics query.
attr_accessor :query

# Request type for the histogram request.
# Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
attr_accessor :request_type

# Timeseries, scalar, or event list response. Event list response formats are supported by Geomap widgets.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/query_value_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,7 @@ class QueryValueWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# TODO.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/sunburst_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ class SunburstWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/table_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class TableWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Query definition.
# Query definition. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/timeseries_widget_definition.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class TimeseriesWidgetDefinition
# List of custom links.
attr_accessor :custom_links

# List of widget events.
# List of widget events. Deprecated - Use `overlay` request type instead.
attr_accessor :events

# Columns displayed in the legend.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/timeseries_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ class TimeseriesWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/toplist_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ class ToplistWidgetRequest
# The log query.
attr_accessor :profile_metrics_query

# Widget query.
# Widget query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/tree_map_widget_request.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ class TreeMapWidgetRequest
# List of formulas that operate on queries.
attr_accessor :formulas

# The widget metrics query.
# The widget metrics query. Deprecated - Use `queries` and `formulas` instead.
attr_accessor :q

# List of queries that can be returned directly or used in formulas.
Expand Down
3 changes: 3 additions & 0 deletions lib/datadog_api_client/v1/models/widget_event.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ module DatadogAPIClient::V1
#
# See the dedicated [Events JSON schema documentation](https://docs.datadoghq.com/dashboards/graphing_json/widget_json/#events-schema)
# to learn how to build the `<EVENTS_SCHEMA>`.
#
# @deprecated This model is deprecated.
class WidgetEvent
include BaseGenericModel

Expand Down Expand Up @@ -54,6 +56,7 @@ def self.openapi_types
# @param attributes [Hash] Model attributes in the form of hash
# @!visibility private
def initialize(attributes = {})
warn "[DEPRECATION] `WidgetEvent` is deprecated."
if (!attributes.is_a?(Hash))
fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V1::WidgetEvent` initialize method"
end
Expand Down
2 changes: 1 addition & 1 deletion lib/datadog_api_client/v1/models/widget_histogram_request_type.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
require 'time'

module DatadogAPIClient::V1
# Request type for the histogram request.
# Request type for distribution of point values for distribution metrics. Query space aggregator must be `histogram:<metric name>` for points distributions.
class WidgetHistogramRequestType
include BaseEnumModel

Expand Down
Loading