Skip to content

Commit 37d9d78

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Regenerate client from commit 7d970a8 of spec repo (#171)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent b440e25 commit 37d9d78

File tree

6 files changed

+22
-21
lines changed

6 files changed

+22
-21
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.3.0",
7-
"regenerated": "2020-11-24 16:52:18.458924",
8-
"spec_repo_commit": "7af099d"
7+
"regenerated": "2020-11-25 09:41:14.966909",
8+
"spec_repo_commit": "7d970a8"
99
},
1010
"v2": {
1111
"apigentools_version": "1.3.0",
12-
"regenerated": "2020-11-24 16:52:29.040713",
13-
"spec_repo_commit": "7af099d"
12+
"regenerated": "2020-11-25 09:41:26.740419",
13+
"spec_repo_commit": "7d970a8"
1414
}
1515
}
1616
}

docs/v1/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ Class | Method | HTTP request | Description
273273
*UsageMeteringApi* | [**get_usage_synthetics_api**](UsageMeteringApi.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks
274274
*UsageMeteringApi* | [**get_usage_synthetics_browser**](UsageMeteringApi.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks
275275
*UsageMeteringApi* | [**get_usage_timeseries**](UsageMeteringApi.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics
276-
*UsageMeteringApi* | [**get_usage_top_avg_metrics**](UsageMeteringApi.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get top 500 custom metrics by hourly average
276+
*UsageMeteringApi* | [**get_usage_top_avg_metrics**](UsageMeteringApi.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get top custom metrics by hourly average
277277
*UsageMeteringApi* | [**get_usage_trace**](UsageMeteringApi.md#get_usage_trace) | **GET** /api/v1/usage/traces | Get hourly usage for Trace Search
278278
*UsersApi* | [**create_user**](UsersApi.md#create_user) | **POST** /api/v1/user | Create a user
279279
*UsersApi* | [**disable_user**](UsersApi.md#disable_user) | **DELETE** /api/v1/user/{user_handle} | Disable a user

docs/v1/UsageMeteringApi.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ Method | HTTP request | Description
3030
[**get_usage_synthetics_api**](UsageMeteringApi.md#get_usage_synthetics_api) | **GET** /api/v1/usage/synthetics_api | Get hourly usage for Synthetics API Checks
3131
[**get_usage_synthetics_browser**](UsageMeteringApi.md#get_usage_synthetics_browser) | **GET** /api/v1/usage/synthetics_browser | Get hourly usage for Synthetics Browser Checks
3232
[**get_usage_timeseries**](UsageMeteringApi.md#get_usage_timeseries) | **GET** /api/v1/usage/timeseries | Get hourly usage for custom metrics
33-
[**get_usage_top_avg_metrics**](UsageMeteringApi.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get top 500 custom metrics by hourly average
33+
[**get_usage_top_avg_metrics**](UsageMeteringApi.md#get_usage_top_avg_metrics) | **GET** /api/v1/usage/top_avg_metrics | Get top custom metrics by hourly average
3434
[**get_usage_trace**](UsageMeteringApi.md#get_usage_trace) | **GET** /api/v1/usage/traces | Get hourly usage for Trace Search
3535

3636

@@ -2481,7 +2481,7 @@ Name | Type | Description | Notes
24812481
# **get_usage_top_avg_metrics**
24822482
> UsageTopAvgMetricsResponse get_usage_top_avg_metrics(month)
24832483
2484-
Get top 500 custom metrics by hourly average
2484+
Get top custom metrics by hourly average
24852485

24862486
Get top [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average.
24872487

@@ -2527,11 +2527,11 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
25272527
names = [
25282528
"names_example",
25292529
] # [str] | Comma-separated list of metric names. (optional)
2530-
limit = 500 # int | Maximum number of results to return. (optional) if omitted the server will use the default value of 500
2530+
limit = 500 # int | Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. (optional) if omitted the server will use the default value of 500
25312531

25322532
# example passing only required values which don't have defaults set
25332533
try:
2534-
# Get top 500 custom metrics by hourly average
2534+
# Get top custom metrics by hourly average
25352535
api_response = api_instance.get_usage_top_avg_metrics(month)
25362536
pprint(api_response)
25372537
except datadog_api_client.v1.ApiException as e:
@@ -2540,7 +2540,7 @@ with datadog_api_client.v1.ApiClient(configuration) as api_client:
25402540
# example passing only required values which don't have defaults set
25412541
# and optional values
25422542
try:
2543-
# Get top 500 custom metrics by hourly average
2543+
# Get top custom metrics by hourly average
25442544
api_response = api_instance.get_usage_top_avg_metrics(month, names=names, limit=limit)
25452545
pprint(api_response)
25462546
except datadog_api_client.v1.ApiException as e:
@@ -2553,7 +2553,7 @@ Name | Type | Description | Notes
25532553
------------- | ------------- | ------------- | -------------
25542554
**month** | **datetime**| Datetime in ISO-8601 format, UTC, precise to month: [YYYY-MM] for usage beginning at this hour. |
25552555
**names** | **[str]**| Comma-separated list of metric names. | [optional]
2556-
**limit** | **int**| Maximum number of results to return. | [optional] if omitted the server will use the default value of 500
2556+
**limit** | **int**| Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified. | [optional] if omitted the server will use the default value of 500
25572557

25582558
### Return type
25592559

src/datadog_api_client/v1/api/usage_metering_api.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3378,7 +3378,7 @@ def __get_usage_top_avg_metrics(
33783378
month,
33793379
**kwargs
33803380
):
3381-
"""Get top 500 custom metrics by hourly average # noqa: E501
3381+
"""Get top custom metrics by hourly average # noqa: E501
33823382
33833383
Get top [custom metrics](https://docs.datadoghq.com/developers/metrics/custom_metrics/) by hourly average. # noqa: E501
33843384
This method makes a synchronous HTTP request by default. To make an
@@ -3392,7 +3392,7 @@ def __get_usage_top_avg_metrics(
33923392
33933393
Keyword Args:
33943394
names ([str]): Comma-separated list of metric names.. [optional]
3395-
limit (int): Maximum number of results to return.. [optional] if omitted the server will use the default value of 500
3395+
limit (int): Maximum number of results to return (between 1 and 5000) - defaults to 500 results if limit not specified.. [optional] if omitted the server will use the default value of 500
33963396
_return_http_data_only (bool): response data without head status
33973397
code and headers. Default is True.
33983398
_preload_content (bool): if False, the urllib3.HTTPResponse object

src/datadog_api_client/v1/openapi.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16063,7 +16063,8 @@ paths:
1606316063
items:
1606416064
type: string
1606516065
type: array
16066-
- description: Maximum number of results to return.
16066+
- description: Maximum number of results to return (between 1 and 5000) - defaults
16067+
to 500 results if limit not specified.
1606716068
in: query
1606816069
name: limit
1606916070
required: false
@@ -16092,7 +16093,7 @@ paths:
1609216093
schema:
1609316094
$ref: '#/components/schemas/APIErrorResponse'
1609416095
description: Forbidden - User is not authorized
16095-
summary: Get top 500 custom metrics by hourly average
16096+
summary: Get top custom metrics by hourly average
1609616097
tags:
1609716098
- Usage Metering
1609816099
/api/v1/usage/traces:

tests/v1/features/usage_metering.feature

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -102,12 +102,6 @@ Feature: Usage Metering
102102
When the request is sent
103103
Then the response status is 200 OK
104104

105-
@generated @skip
106-
Scenario: Get top 500 custom metrics by hourly average returns "OK" response
107-
Given new "GetUsageTopAvgMetrics" request
108-
When the request is sent
109-
Then the response status is 200 OK
110-
111105
@generated @skip
112106
Scenario: Get the list of available daily custom reports returns "OK" response
113107
Given operation "GetDailyCustomReports" enabled
@@ -186,3 +180,9 @@ Feature: Usage Metering
186180
And new "GetUsageAttribution" request
187181
When the request is sent
188182
Then the response status is 200 OK
183+
184+
@generated @skip
185+
Scenario: Get top custom metrics by hourly average returns "OK" response
186+
Given new "GetUsageTopAvgMetrics" request
187+
When the request is sent
188+
Then the response status is 200 OK

0 commit comments

Comments
 (0)