Regenerate client from commit 30d495fb of spec repo

Author: ci.datadog-api-spec

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-02 14:34:51.265300",
-            "spec_repo_commit": "48a734bf"
+            "regenerated": "2024-12-02 16:22:20.636361",
+            "spec_repo_commit": "30d495fb"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-02 14:34:51.283805",
-            "spec_repo_commit": "48a734bf"
+            "regenerated": "2024-12-02 16:22:20.654685",
+            "spec_repo_commit": "30d495fb"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -15676,6 +15676,35 @@ components:
       - COUNT
       - RATE
       - GAUGE
+    MetricMetaPage:
+      description: Paging attributes. Only present if pagination query parameters
+        were provided.
+      properties:
+        cursor:
+          description: The cursor used to get the current results, if any.
+          type: string
+        limit:
+          description: Number of results returned
+          format: int32
+          maximum: 20000
+          minimum: 0
+          type: integer
+        next_cursor:
+          description: The cursor used to get the next results, if any.
+          nullable: true
+          type: string
+        type:
+          $ref: '#/components/schemas/MetricMetaPageType'
+      type: object
+    MetricMetaPageType:
+      default: cursor_limit
+      description: Type of Metric pagination.
+      enum:
+      - cursor_limit
+      example: cursor_limit
+      type: string
+      x-enum-varnames:
+      - CURSOR_LIMIT
     MetricMetadata:
       description: Metadata for the metric.
       properties:
@@ -15758,6 +15787,12 @@ components:
           maximum: 1000
           type: integer
       type: object
+    MetricPaginationMeta:
+      description: Response metadata object.
+      properties:
+        pagination:
+          $ref: '#/components/schemas/MetricMetaPage'
+      type: object
     MetricPayload:
       description: The metrics' payload.
       properties:
@@ -16234,6 +16269,10 @@ components:
           items:
             $ref: '#/components/schemas/MetricsAndMetricTagConfigurations'
           type: array
+        links:
+          $ref: '#/components/schemas/MetricsListResponseLinks'
+        meta:
+          $ref: '#/components/schemas/MetricPaginationMeta'
       readOnly: true
       type: object
     MetricsDataSource:
@@ -16247,6 +16286,29 @@ components:
       x-enum-varnames:
       - METRICS
       - CLOUD_COST
+    MetricsListResponseLinks:
+      description: Pagination links. Only present if pagination query parameters were
+        provided.
+      properties:
+        first:
+          description: Link to the first page.
+          type: string
+        last:
+          description: Link to the last page.
+          nullable: true
+          type: string
+        next:
+          description: Link to the next page.
+          nullable: true
+          type: string
+        prev:
+          description: Link to previous page.
+          nullable: true
+          type: string
+        self:
+          description: Link to current page.
+          type: string
+      type: object
     MetricsScalarQuery:
       description: An individual scalar metrics query.
       properties:
@@ -35280,7 +35342,12 @@ paths:
     get:
       description: "Returns all metrics that can be configured in the Metrics Summary
         page or with Metrics without Limits\u2122 (matching additional filters if
-        specified)."
+        specified).\nOptionally, paginate by using the `page[cursor]` and/or `page[size]`
+        query parameters.\nTo 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.\nOnce the `meta.pagination.next_cursor` value is null,
+        all pages have been retrieved."
       operationId: ListTagConfigurations
       parameters:
       - description: Filter custom metrics that have configured tags.
@@ -35345,6 +35412,27 @@ paths:
         schema:
           format: int64
           type: integer
+      - description: Maximum number of results returned.
+        in: query
+        name: page[size]
+        required: false
+        schema:
+          default: 10000
+          format: int32
+          maximum: 10000
+          minimum: 1
+          type: integer
+      - description: 'String to query the next page of results.
+
+          This key is provided with each valid response from the API in `meta.pagination.next_cursor`.
+
+          Once the `meta.pagination.next_cursor` key is null, all pages have been
+          retrieved.'
+        in: query
+        name: page[cursor]
+        required: false
+        schema:
+          type: string
       responses:
         '200':
           content:
@@ -35378,6 +35466,11 @@ paths:
       summary: Get a list of metrics
       tags:
       - Metrics
+      x-pagination:
+        cursorParam: page[cursor]
+        cursorPath: meta.pagination.next_cursor
+        limitParam: page[size]
+        resultsPath: data
       x-permission:
         operator: OR
         permissions:

docs/datadog_api_client.v2.model.rst

@@ -6759,6 +6759,20 @@ datadog\_api\_client.v2.model.metric\_intake\_type module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.metric\_meta\_page module
+-------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.metric_meta_page
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v2.model.metric\_meta\_page\_type module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.metric_meta_page_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.metric\_metadata module
 -----------------------------------------------------
 
@@ -6801,6 +6815,13 @@ datadog\_api\_client.v2.model.metric\_origin module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.metric\_pagination\_meta module
+-------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.metric_pagination_meta
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.metric\_payload module
 ----------------------------------------------------
 
@@ -7004,6 +7025,13 @@ datadog\_api\_client.v2.model.metrics\_data\_source module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v2.model.metrics\_list\_response\_links module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.metrics_list_response_links
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v2.model.metrics\_scalar\_query module
 -----------------------------------------------------------
 

examples/v2/metrics/ListTagConfigurations_3969783727.py

@@ -0,0 +1,13 @@
+"""
+Get a list of metrics returns "Success" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.metrics_api import MetricsApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = MetricsApi(api_client)
+    items = api_instance.list_tag_configurations_with_pagination()
+    for item in items:
+        print(item)

src/datadog_api_client/v2/api/metrics_api.py

@@ -3,11 +3,14 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
+import collections
 from typing import Any, Dict, Union
 
 from datadog_api_client.api_client import ApiClient, Endpoint as _Endpoint
 from datadog_api_client.configuration import Configuration
 from datadog_api_client.model_utils import (
+    set_attribute_from_path,
+    get_attribute_from_path,
     UnsetType,
     unset,
 )
@@ -17,6 +20,7 @@
 from datadog_api_client.v2.model.metric_tag_configuration_metric_type_category import (
     MetricTagConfigurationMetricTypeCategory,
 )
+from datadog_api_client.v2.model.metrics_and_metric_tag_configurations import MetricsAndMetricTagConfigurations
 from datadog_api_client.v2.model.metric_bulk_tag_config_response import MetricBulkTagConfigResponse
 from datadog_api_client.v2.model.metric_bulk_tag_config_delete_request import MetricBulkTagConfigDeleteRequest
 from datadog_api_client.v2.model.metric_bulk_tag_config_create_request import MetricBulkTagConfigCreateRequest
@@ -329,6 +333,20 @@ def __init__(self, api_client=None):
                     "attribute": "window[seconds]",
                     "location": "query",
                 },
+                "page_size": {
+                    "validation": {
+                        "inclusive_maximum": 10000,
+                        "inclusive_minimum": 1,
+                    },
+                    "openapi_types": (int,),
+                    "attribute": "page[size]",
+                    "location": "query",
+                },
+                "page_cursor": {
+                    "openapi_types": (str,),
+                    "attribute": "page[cursor]",
+                    "location": "query",
+                },
             },
             headers_map={
                 "accept": ["application/json"],
@@ -674,10 +692,15 @@ def list_tag_configurations(
         filter_queried: Union[bool, UnsetType] = unset,
         filter_tags: Union[str, UnsetType] = unset,
         window_seconds: Union[int, UnsetType] = unset,
+        page_size: Union[int, UnsetType] = unset,
+        page_cursor: Union[str, UnsetType] = unset,
     ) -> MetricsAndMetricTagConfigurationsResponse:
         """Get a list of metrics.
 
         Returns all metrics that can be configured in the Metrics Summary page or with Metrics without Limits™ (matching additional filters if specified).
+        Optionally, paginate by using the ``page[cursor]`` and/or ``page[size]`` query parameters.
+        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.
+        Once the ``meta.pagination.next_cursor`` value is null, all pages have been retrieved.
 
         :param filter_configured: Filter custom metrics that have configured tags.
         :type filter_configured: bool, optional
@@ -697,6 +720,12 @@ def list_tag_configurations(
         :param window_seconds: The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.
             Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).
         :type window_seconds: int, optional
+        :param page_size: Maximum number of results returned.
+        :type page_size: int, optional
+        :param page_cursor: String to query the next page of results.
+            This key is provided with each valid response from the API in ``meta.pagination.next_cursor``.
+            Once the ``meta.pagination.next_cursor`` key is null, all pages have been retrieved.
+        :type page_cursor: str, optional
         :rtype: MetricsAndMetricTagConfigurationsResponse
         """
         kwargs: Dict[str, Any] = {}
@@ -721,8 +750,100 @@ def list_tag_configurations(
         if window_seconds is not unset:
             kwargs["window_seconds"] = window_seconds
 
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_cursor is not unset:
+            kwargs["page_cursor"] = page_cursor
+
         return self._list_tag_configurations_endpoint.call_with_http_info(**kwargs)
 
+    def list_tag_configurations_with_pagination(
+        self,
+        *,
+        filter_configured: Union[bool, UnsetType] = unset,
+        filter_tags_configured: Union[str, UnsetType] = unset,
+        filter_metric_type: Union[MetricTagConfigurationMetricTypeCategory, UnsetType] = unset,
+        filter_include_percentiles: Union[bool, UnsetType] = unset,
+        filter_queried: Union[bool, UnsetType] = unset,
+        filter_tags: Union[str, UnsetType] = unset,
+        window_seconds: Union[int, UnsetType] = unset,
+        page_size: Union[int, UnsetType] = unset,
+        page_cursor: Union[str, UnsetType] = unset,
+    ) -> collections.abc.Iterable[MetricsAndMetricTagConfigurations]:
+        """Get a list of metrics.
+
+        Provide a paginated version of :meth:`list_tag_configurations`, returning all items.
+
+        :param filter_configured: Filter custom metrics that have configured tags.
+        :type filter_configured: bool, optional
+        :param filter_tags_configured: Filter tag configurations by configured tags.
+        :type filter_tags_configured: str, optional
+        :param filter_metric_type: Filter metrics by metric type.
+        :type filter_metric_type: MetricTagConfigurationMetricTypeCategory, optional
+        :param filter_include_percentiles: Filter distributions with additional percentile
+            aggregations enabled or disabled.
+        :type filter_include_percentiles: bool, optional
+        :param filter_queried: (Beta) Filter custom metrics that have or have not been queried in the specified window[seconds].
+            If no window is provided or the window is less than 2 hours, a default of 2 hours will be applied.
+        :type filter_queried: bool, optional
+        :param filter_tags: Filter metrics that have been submitted with the given tags. Supports boolean and wildcard expressions.
+            Can only be combined with the filter[queried] filter.
+        :type filter_tags: str, optional
+        :param window_seconds: The number of seconds of look back (from now) to apply to a filter[tag] or filter[queried] query.
+            Default value is 3600 (1 hour), maximum value is 2,592,000 (30 days).
+        :type window_seconds: int, optional
+        :param page_size: Maximum number of results returned.
+        :type page_size: int, optional
+        :param page_cursor: String to query the next page of results.
+            This key is provided with each valid response from the API in ``meta.pagination.next_cursor``.
+            Once the ``meta.pagination.next_cursor`` key is null, all pages have been retrieved.
+        :type page_cursor: str, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[MetricsAndMetricTagConfigurations]
+        """
+        kwargs: Dict[str, Any] = {}
+        if filter_configured is not unset:
+            kwargs["filter_configured"] = filter_configured
+
+        if filter_tags_configured is not unset:
+            kwargs["filter_tags_configured"] = filter_tags_configured
+
+        if filter_metric_type is not unset:
+            kwargs["filter_metric_type"] = filter_metric_type
+
+        if filter_include_percentiles is not unset:
+            kwargs["filter_include_percentiles"] = filter_include_percentiles
+
+        if filter_queried is not unset:
+            kwargs["filter_queried"] = filter_queried
+
+        if filter_tags is not unset:
+            kwargs["filter_tags"] = filter_tags
+
+        if window_seconds is not unset:
+            kwargs["window_seconds"] = window_seconds
+
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_cursor is not unset:
+            kwargs["page_cursor"] = page_cursor
+
+        local_page_size = get_attribute_from_path(kwargs, "page_size", 10000)
+        endpoint = self._list_tag_configurations_endpoint
+        set_attribute_from_path(kwargs, "page_size", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "data",
+            "cursor_param": "page_cursor",
+            "cursor_path": "meta.pagination.next_cursor",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def list_tags_by_metric_name(
         self,
         metric_name: str,