Skip to content

Commit

Permalink
Update Metrics Query descriptions and scopes (#1540)
Browse files Browse the repository at this point in the history
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
  • Loading branch information
api-clients-generation-pipeline[bot] and ci.datadog-api-spec committed Jun 28, 2023
1 parent f1f972a commit 8788749
Show file tree
Hide file tree
Showing 7 changed files with 22 additions and 19 deletions.
8 changes: 4 additions & 4 deletions .apigentools-info
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-26 07:19:26.221149",
"spec_repo_commit": "6831ab50"
"regenerated": "2023-06-28 13:29:53.237675",
"spec_repo_commit": "042157e1"
},
"v2": {
"apigentools_version": "1.6.4",
"regenerated": "2023-06-26 07:19:26.233789",
"spec_repo_commit": "6831ab50"
"regenerated": "2023-06-28 13:29:53.250399",
"spec_repo_commit": "042157e1"
}
}
}
23 changes: 13 additions & 10 deletions .generator/schemas/v2/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3927,8 +3927,8 @@ components:
aggregation:
$ref: '#/components/schemas/EventsAggregation'
metric:
description: Metric whose calculated value should be used to define the
sort order of a query's results.
description: The metric's calculated value which should be used to define
the sort order of a query's results.
example: '@duration'
type: string
order:
Expand Down Expand Up @@ -8903,7 +8903,8 @@ components:
type: object
MetricsAggregator:
default: avg
description: The type of aggregation that can be performed on metrics queries.
description: The type of aggregation that can be performed on metrics-based
queries.
enum:
- avg
- min
Expand Down Expand Up @@ -21082,7 +21083,7 @@ paths:
resultsPath: data
/api/v2/query/scalar:
post:
description: 'Query scalar values (as seen on Query Value, Table and Toplist
description: 'Query scalar values (as seen on Query Value, Table, and Toplist
widgets).

Multiple data sources are supported with the ability to
Expand Down Expand Up @@ -21119,13 +21120,13 @@ paths:
tags:
- Metrics
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is GA for the metrics, real user monitoring
(RUM) and cloud cost data sources.
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
(RUM), and Cloud Cost Management data sources.

Support for logs is in beta. We are gradually onboarding support for more
sources. If you have any

feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
/api/v2/query/timeseries:
post:
description: 'Query timeseries data across various data sources and
Expand Down Expand Up @@ -21158,17 +21159,19 @@ paths:
appKeyAuth: []
- AuthZ:
- timeseries_query
- metrics_read
- metric_tags_write
summary: Query timeseries data across multiple products
tags:
- Metrics
x-codegen-request-body-name: body
x-unstable: '**Note**: This endpoint is GA for the metrics, real user monitoring
(RUM) and cloud cost data sources.
x-unstable: '**Note**: This endpoint is GA for Metrics, Real User Monitoring
(RUM), and Cloud Cost Management data sources.

Support for logs is in beta. We are gradually onboarding support for more
sources. If you have any

feedback, contact [Datadog support](https://docs.datadoghq.com/help/).'
feedback, contact [Datadog Support](https://docs.datadoghq.com/help/).'
/api/v2/restriction_policy/{resource_id}:
delete:
description: Deletes the restriction policy associated with a specified resource.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/api/metrics_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -717,7 +717,7 @@ def query_scalar_data(
) -> ScalarFormulaQueryResponse:
"""Query scalar data across multiple products.
Query scalar values (as seen on Query Value, Table and Toplist widgets).
Query scalar values (as seen on Query Value, Table, and Toplist widgets).
Multiple data sources are supported with the ability to
process the data using formulas and functions.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/model/events_group_by_sort.py
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ def __init__(
:param aggregation: The type of aggregation that can be performed on events-based queries.
:type aggregation: EventsAggregation
:param metric: Metric whose calculated value should be used to define the sort order of a query's results.
:param metric: The metric's calculated value which should be used to define the sort order of a query's results.
:type metric: str, optional
:param order: Direction of sort.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/model/metrics_aggregator.py
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

class MetricsAggregator(ModelSimple):
"""
The type of aggregation that can be performed on metrics queries.
The type of aggregation that can be performed on metrics-based queries.
:param value: If omitted defaults to "avg". Must be one of ["avg", "min", "max", "sum", "last", "percentile", "mean", "l2norm", "area"].
:type value: str
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/model/metrics_scalar_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ def __init__(
"""
An individual scalar metrics query.
:param aggregator: The type of aggregation that can be performed on metrics queries.
:param aggregator: The type of aggregation that can be performed on metrics-based queries.
:type aggregator: MetricsAggregator
:param data_source: A data source that is powered by the Metrics platform.
Expand Down
2 changes: 1 addition & 1 deletion src/datadog_api_client/v2/model/scalar_query.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ def __init__(self, **kwargs):
"""
An individual scalar query to one of the basic Datadog data sources.
:param aggregator: The type of aggregation that can be performed on metrics queries.
:param aggregator: The type of aggregation that can be performed on metrics-based queries.
:type aggregator: MetricsAggregator
:param data_source: A data source that is powered by the Metrics platform.
Expand Down

0 comments on commit 8788749

Please sign in to comment.