From 40419998fea137ba534b0ed62d36d831baeb63f6 Mon Sep 17 00:00:00 2001 From: Ed Ropple Date: Mon, 1 Nov 2021 10:06:01 -0400 Subject: [PATCH] [release] 3.1.0 --- docs/MetricsApi.md | 4 ++-- gen/generator-config.json | 2 +- mux_python/api/metrics_api.py | 4 ++-- 3 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/MetricsApi.md b/docs/MetricsApi.md index 3c22827..e73d954 100644 --- a/docs/MetricsApi.md +++ b/docs/MetricsApi.md @@ -53,7 +53,7 @@ timeframe = ['timeframe_example'] # list[str] | Timeframe window to limit result filters = ['filters_example'] # list[str] | Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. (optional) measurement = 'measurement_example' # str | Measurement for the provided metric. If omitted, the default for the metric will be used. (optional) order_direction = 'order_direction_example' # str | Sort order. (optional) -group_by = 'group_by_example' # str | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. (optional) +group_by = 'group_by_example' # str | Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. (optional) try: # Get metric timeseries data @@ -72,7 +72,7 @@ Name | Type | Description | Notes **filters** | [**list[str]**](str.md)| Filter key:value pairs. Must be provided as an array query string parameter (e.g. filters[]=operating_system:windows&filters[]=country:US). Possible filter names are the same as returned by the List Filters endpoint. | [optional] **measurement** | **str**| Measurement for the provided metric. If omitted, the default for the metric will be used. | [optional] **order_direction** | **str**| Sort order. | [optional] - **group_by** | **str**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. | [optional] + **group_by** | **str**| Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. | [optional] ### Return type diff --git a/gen/generator-config.json b/gen/generator-config.json index 89771f2..82ba408 100644 --- a/gen/generator-config.json +++ b/gen/generator-config.json @@ -2,5 +2,5 @@ "!!source": "https://github.com/OpenAPITools/openapi-generator/blob/master/docs/generators/python.md", "packageName": "mux_python", "projectName": "mux_python", - "packageVersion": "3.0.0" + "packageVersion": "3.1.0" } diff --git a/mux_python/api/metrics_api.py b/mux_python/api/metrics_api.py index ec283f3..05c3825 100644 --- a/mux_python/api/metrics_api.py +++ b/mux_python/api/metrics_api.py @@ -57,7 +57,7 @@ def get_metric_timeseries_data(self, metric_id, **kwargs): # noqa: E501 :type measurement: str :param order_direction: Sort order. :type order_direction: str - :param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. + :param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. :type group_by: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional @@ -97,7 +97,7 @@ def get_metric_timeseries_data_with_http_info(self, metric_id, **kwargs): # noq :type measurement: str :param order_direction: Sort order. :type order_direction: str - :param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the supplied timeframe. + :param group_by: Time granularity to group results by. If this value is omitted, a default granularity is chosen based on the timeframe. For timeframes of 6 hours or less, the default granularity is `ten_minutes`. Between 6 hours and 15 hours inclusive, the default granularity is `hour`. The granularity of timeframes that exceed 15 hours is `day`. This default behaviour is subject to change; it is strongly suggested that you explicitly specify the granularity. :type group_by: str :param async_req: Whether to execute the request asynchronously. :type async_req: bool, optional