add docs for pagination in /api/v2/metrics endpoint (#2174)

Co-authored-by: ci.datadog-api-spec <[email protected]>

Author: api-clients-generation-pipeline[bot]

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-11 20:35:43.977265",
-            "spec_repo_commit": "7b62d196"
+            "regenerated": "2024-12-12 13:29:31.187829",
+            "spec_repo_commit": "f0c3c0f4"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-12-11 20:35:43.995051",
-            "spec_repo_commit": "7b62d196"
+            "regenerated": "2024-12-12 13:29:31.206413",
+            "spec_repo_commit": "f0c3c0f4"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -16012,6 +16012,36 @@ 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.
+          nullable: true
+          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:
@@ -16094,6 +16124,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:
@@ -16570,6 +16606,10 @@ components:
           items:
             $ref: '#/components/schemas/MetricsAndMetricTagConfigurations'
           type: array
+        links:
+          $ref: '#/components/schemas/MetricsListResponseLinks'
+        meta:
+          $ref: '#/components/schemas/MetricPaginationMeta'
       readOnly: true
       type: object
     MetricsDataSource:
@@ -16583,6 +16623,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:
@@ -35773,7 +35836,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.
@@ -35838,6 +35906,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:
@@ -35871,6 +35960,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

@@ -6815,6 +6815,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
 -----------------------------------------------------
 
@@ -6857,6 +6871,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
 ----------------------------------------------------
 
@@ -7060,6 +7081,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,15 @@
+"""
+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(
+        page_size=2,
+    )
+    for item in items:
+        print(item)