Skip to content

Commit ca27c72

Browse files
author
ci.datadog-api-spec
committed
Regenerate client from commit e5c97ff of spec repo
1 parent ab6eca5 commit ca27c72

2 files changed

Lines changed: 60 additions & 101 deletions

File tree

.generator/schemas/v2/openapi.yaml

Lines changed: 32 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -91522,111 +91522,92 @@ paths:
9152291522
- logs_read_data
9152391523
/api/v2/metrics:
9152491524
get:
91525-
description: 'Returns all metrics for your organization that match the given
91526-
filter parameters.
91527-
91528-
Optionally, paginate by using the `page[cursor]` and/or `page[size]` query
91529-
parameters.
91530-
91531-
To fetch the first page, pass in a query parameter with either a valid `page[size]`
91532-
or an empty cursor like `page[cursor]=`. To fetch the next page, pass in the
91533-
`next_cursor` value from the response as the new `page[cursor]` value.
91534-
91535-
Once the `meta.pagination.next_cursor` value is null, all pages have been
91536-
retrieved.'
91525+
description: Get a list of actively reporting metrics for your organization.
91526+
Pagination is optional using the `page[cursor]` and `page[size]` query parameters.
9153791527
operationId: ListTagConfigurations
9153891528
parameters:
91539-
- description: Filter custom metrics that have configured tags.
91529+
- description: Only return custom metrics that have been configured with Metrics
91530+
Without Limits.
9154091531
example: true
9154191532
in: query
9154291533
name: filter[configured]
9154391534
required: false
9154491535
schema:
9154591536
type: boolean
91546-
- description: Filter tag configurations by configured tags.
91547-
example: app
91537+
- description: Only return metrics that have the given tag key(s) in their Metrics
91538+
Without Limits configuration (included or excluded).
91539+
example: app,env
9154891540
in: query
9154991541
name: filter[tags_configured]
9155091542
required: false
9155191543
schema:
9155291544
description: Tag keys to filter by.
9155391545
type: string
91554-
- description: Filter metrics by metric type.
91546+
- description: Only return metrics of the given metric type.
9155591547
in: query
9155691548
name: filter[metric_type]
9155791549
required: false
9155891550
schema:
9155991551
$ref: '#/components/schemas/MetricTagConfigurationMetricTypeCategory'
91560-
- description: 'Filter distributions with additional percentile
91561-
91562-
aggregations enabled or disabled.'
91552+
- description: Only return distribution metrics that have percentile aggregations
91553+
enabled (true) or disabled (false).
9156391554
example: true
9156491555
in: query
9156591556
name: filter[include_percentiles]
9156691557
required: false
9156791558
schema:
9156891559
type: boolean
91569-
- description: '(Preview) Filter custom metrics that have or have not been queried
91570-
in the specified window[seconds].
91571-
91572-
If no window is provided or the window is less than 2 hours, a default of
91573-
2 hours will be applied.'
91560+
- description: Only return metrics that have been queried (true) or not queried
91561+
(false) in the look back window. Set the window with `filter[queried][window][seconds]`;
91562+
if omitted, a default window is used.
9157491563
example: true
9157591564
in: query
9157691565
name: filter[queried]
9157791566
required: false
9157891567
schema:
9157991568
type: boolean
91580-
- description: 'The number of seconds of look back (from now) used by the `filter[queried]`
91581-
filter logic.
91582-
91583-
Must be sent with `filter[queried]` and is only applied when `filter[queried]=true`.
91584-
91585-
If `filter[queried]=false`, this parameter is ignored and default queried-window
91586-
behavior applies.
91587-
91588-
If `filter[queried]` is not provided, sending this parameter returns a 400.
91589-
91590-
For example: `GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000`.'
91569+
- description: Only return metrics that have been queried or not queried in
91570+
the specified window. Dependent on being sent with `filter[queried]`.
9159191571
example: 15552000
9159291572
in: query
9159391573
name: filter[queried][window][seconds]
9159491574
required: false
9159591575
schema:
91576+
default: 2592000
9159691577
format: int64
9159791578
maximum: 15552000
91598-
minimum: 0
91579+
minimum: 1
9159991580
type: integer
91600-
- description: 'Filter metrics that have been submitted with the given tags.
91601-
Supports boolean and wildcard expressions.
91602-
91603-
Can only be combined with the filter[queried] filter.'
91604-
example: env IN (staging,test) AND service:web
91581+
- description: Only return metrics that were submitted with tags matching this
91582+
expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
91583+
example: env IN (staging,test) AND service:web*
9160591584
in: query
9160691585
name: filter[tags]
9160791586
required: false
9160891587
schema:
9160991588
type: string
91610-
- description: (Preview) Filter metrics that are used in dashboards, monitors,
91611-
notebooks, SLOs.
91589+
- description: Only return metrics that are used in at least one dashboard,
91590+
monitor, notebook, or SLO.
9161291591
example: true
9161391592
in: query
9161491593
name: filter[related_assets]
9161591594
required: false
9161691595
schema:
9161791596
type: boolean
91618-
- description: 'The number of seconds of look back (from now) to apply to a
91619-
filter[tag] query.
91620-
91621-
Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).'
91597+
- description: Only return metrics that have been actively reporting in the
91598+
specified window.
9162291599
example: 3600
9162391600
in: query
9162491601
name: window[seconds]
9162591602
required: false
9162691603
schema:
91604+
default: 3600
9162791605
format: int64
91606+
maximum: 2592000
91607+
minimum: 1
9162891608
type: integer
91629-
- description: Maximum number of results returned.
91609+
- description: Maximum number of results per page. Use with `page[cursor]` for
91610+
pagination.
9163091611
in: query
9163191612
name: page[size]
9163291613
required: false
@@ -91636,12 +91617,9 @@ paths:
9163691617
maximum: 10000
9163791618
minimum: 1
9163891619
type: integer
91639-
- description: 'String to query the next page of results.
91640-
91641-
This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
91642-
91643-
Once the `meta.pagination.next_cursor` key is null, all pages have been
91644-
retrieved.'
91620+
- description: Cursor for pagination. Use `page[size]` to opt-in to pagination
91621+
and get the first page; for subsequent pages, use the value from `meta.pagination.next_cursor`
91622+
in the response. Pagination is complete when `next_cursor` is null.
9164591623
in: query
9164691624
name: page[cursor]
9164791625
required: false

src/datadog_api_client/v2/api/metrics_api.py

Lines changed: 28 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ def __init__(self, api_client=None):
350350
"filter_queried_window_seconds": {
351351
"validation": {
352352
"inclusive_maximum": 15552000,
353-
"inclusive_minimum": 0,
353+
"inclusive_minimum": 1,
354354
},
355355
"openapi_types": (int,),
356356
"attribute": "filter[queried][window][seconds]",
@@ -367,6 +367,10 @@ def __init__(self, api_client=None):
367367
"location": "query",
368368
},
369369
"window_seconds": {
370+
"validation": {
371+
"inclusive_maximum": 2592000,
372+
"inclusive_minimum": 1,
373+
},
370374
"openapi_types": (int,),
371375
"attribute": "window[seconds]",
372376
"location": "query",
@@ -788,42 +792,29 @@ def list_tag_configurations(
788792
) -> MetricsAndMetricTagConfigurationsResponse:
789793
"""Get a list of metrics.
790794
791-
Returns all metrics for your organization that match the given filter parameters.
792-
Optionally, paginate by using the ``page[cursor]`` and/or ``page[size]`` query parameters.
793-
To fetch the first page, pass in a query parameter with either a valid ``page[size]`` or an empty cursor like ``page[cursor]=``. To fetch the next page, pass in the ``next_cursor`` value from the response as the new ``page[cursor]`` value.
794-
Once the ``meta.pagination.next_cursor`` value is null, all pages have been retrieved.
795+
Get a list of actively reporting metrics for your organization. Pagination is optional using the ``page[cursor]`` and ``page[size]`` query parameters.
795796
796-
:param filter_configured: Filter custom metrics that have configured tags.
797+
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
797798
:type filter_configured: bool, optional
798-
:param filter_tags_configured: Filter tag configurations by configured tags.
799+
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
799800
:type filter_tags_configured: str, optional
800-
:param filter_metric_type: Filter metrics by metric type.
801+
:param filter_metric_type: Only return metrics of the given metric type.
801802
:type filter_metric_type: MetricTagConfigurationMetricTypeCategory, optional
802-
:param filter_include_percentiles: Filter distributions with additional percentile
803-
aggregations enabled or disabled.
803+
:param filter_include_percentiles: Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
804804
:type filter_include_percentiles: bool, optional
805-
:param filter_queried: (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].
806-
If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
805+
:param filter_queried: Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with ``filter[queried][window][seconds]`` ; if omitted, a default window is used.
807806
:type filter_queried: bool, optional
808-
:param filter_queried_window_seconds: The number of seconds of look back (from now) used by the ``filter[queried]`` filter logic.
809-
Must be sent with ``filter[queried]`` and is only applied when ``filter[queried]=true``.
810-
If ``filter[queried]=false`` , this parameter is ignored and default queried-window behavior applies.
811-
If ``filter[queried]`` is not provided, sending this parameter returns a 400.
812-
For example: ``GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000``.
807+
:param filter_queried_window_seconds: Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with ``filter[queried]``.
813808
:type filter_queried_window_seconds: int, optional
814-
:param filter_tags: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
815-
Can only be combined with the filter[queried] filter.
809+
:param filter_tags: Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
816810
:type filter_tags: str, optional
817-
:param filter_related_assets: (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
811+
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
818812
:type filter_related_assets: bool, optional
819-
:param window_seconds: The number of seconds of look back (from now) to apply to a filter[tag] query.
820-
Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
813+
:param window_seconds: Only return metrics that have been actively reporting in the specified window.
821814
:type window_seconds: int, optional
822-
:param page_size: Maximum number of results returned.
815+
:param page_size: Maximum number of results per page. Use with ``page[cursor]`` for pagination.
823816
:type page_size: int, optional
824-
:param page_cursor: String to query the next page of results.
825-
This key is provided with each valid response from the API in ``meta.pagination.next_cursor``.
826-
Once the ``meta.pagination.next_cursor`` key is null, all pages have been retrieved.
817+
:param page_cursor: Cursor for pagination. Use ``page[size]`` to opt-in to pagination and get the first page; for subsequent pages, use the value from ``meta.pagination.next_cursor`` in the response. Pagination is complete when ``next_cursor`` is null.
827818
:type page_cursor: str, optional
828819
:rtype: MetricsAndMetricTagConfigurationsResponse
829820
"""
@@ -882,37 +873,27 @@ def list_tag_configurations_with_pagination(
882873
883874
Provide a paginated version of :meth:`list_tag_configurations`, returning all items.
884875
885-
:param filter_configured: Filter custom metrics that have configured tags.
876+
:param filter_configured: Only return custom metrics that have been configured with Metrics Without Limits.
886877
:type filter_configured: bool, optional
887-
:param filter_tags_configured: Filter tag configurations by configured tags.
878+
:param filter_tags_configured: Only return metrics that have the given tag key(s) in their Metrics Without Limits configuration (included or excluded).
888879
:type filter_tags_configured: str, optional
889-
:param filter_metric_type: Filter metrics by metric type.
880+
:param filter_metric_type: Only return metrics of the given metric type.
890881
:type filter_metric_type: MetricTagConfigurationMetricTypeCategory, optional
891-
:param filter_include_percentiles: Filter distributions with additional percentile
892-
aggregations enabled or disabled.
882+
:param filter_include_percentiles: Only return distribution metrics that have percentile aggregations enabled (true) or disabled (false).
893883
:type filter_include_percentiles: bool, optional
894-
:param filter_queried: (Preview) Filter custom metrics that have or have not been queried in the specified window[seconds].
895-
If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
884+
:param filter_queried: Only return metrics that have been queried (true) or not queried (false) in the look back window. Set the window with ``filter[queried][window][seconds]`` ; if omitted, a default window is used.
896885
:type filter_queried: bool, optional
897-
:param filter_queried_window_seconds: The number of seconds of look back (from now) used by the ``filter[queried]`` filter logic.
898-
Must be sent with ``filter[queried]`` and is only applied when ``filter[queried]=true``.
899-
If ``filter[queried]=false`` , this parameter is ignored and default queried-window behavior applies.
900-
If ``filter[queried]`` is not provided, sending this parameter returns a 400.
901-
For example: ``GET /api/v2/metrics?filter[queried]=true&filter[queried][window][seconds]=15552000``.
886+
:param filter_queried_window_seconds: Only return metrics that have been queried or not queried in the specified window. Dependent on being sent with ``filter[queried]``.
902887
:type filter_queried_window_seconds: int, optional
903-
:param filter_tags: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
904-
Can only be combined with the filter[queried] filter.
888+
:param filter_tags: Only return metrics that were submitted with tags matching this expression. You can use AND, OR, IN, and wildcards (for example, service:web*).
905889
:type filter_tags: str, optional
906-
:param filter_related_assets: (Preview) Filter metrics that are used in dashboards, monitors, notebooks, SLOs.
890+
:param filter_related_assets: Only return metrics that are used in at least one dashboard, monitor, notebook, or SLO.
907891
:type filter_related_assets: bool, optional
908-
:param window_seconds: The number of seconds of look back (from now) to apply to a filter[tag] query.
909-
Default value is 3600 (1 hour), maximum value is 5,184,000 (60 days).
892+
:param window_seconds: Only return metrics that have been actively reporting in the specified window.
910893
:type window_seconds: int, optional
911-
:param page_size: Maximum number of results returned.
894+
:param page_size: Maximum number of results per page. Use with ``page[cursor]`` for pagination.
912895
:type page_size: int, optional
913-
:param page_cursor: String to query the next page of results.
914-
This key is provided with each valid response from the API in ``meta.pagination.next_cursor``.
915-
Once the ``meta.pagination.next_cursor`` key is null, all pages have been retrieved.
896+
:param page_cursor: Cursor for pagination. Use ``page[size]`` to opt-in to pagination and get the first page; for subsequent pages, use the value from ``meta.pagination.next_cursor`` in the response. Pagination is complete when ``next_cursor`` is null.
916897
:type page_cursor: str, optional
917898
918899
:return: A generator of paginated results.

0 commit comments

Comments
 (0)