Add pagination extension to notebook (#1642)

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.5",
-            "regenerated": "2023-09-01 14:18:43.853436",
-            "spec_repo_commit": "fd65b2e4"
+            "regenerated": "2023-09-04 09:06:11.821242",
+            "spec_repo_commit": "a5115137"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-01 14:18:43.873695",
-            "spec_repo_commit": "fd65b2e4"
+            "regenerated": "2023-09-04 09:06:11.834122",
+            "spec_repo_commit": "a5115137"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -26095,6 +26095,7 @@ paths:
         name: count
         required: false
         schema:
+          default: 100
           example: 5
           format: int64
           type: integer
@@ -26179,6 +26180,10 @@ paths:
       summary: Get all notebooks
       tags:
       - Notebooks
+      x-pagination:
+        limitParam: count
+        pageOffsetParam: start
+        resultsPath: data
     post:
       description: Create a notebook using the specified options.
       operationId: CreateNotebook

examples/v1/notebooks/ListNotebooks_788665428.py

@@ -0,0 +1,15 @@
+"""
+Get all notebooks returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.notebooks_api import NotebooksApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = NotebooksApi(api_client)
+    items = api_instance.list_notebooks_with_pagination(
+        count=2,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v1/api/notebooks_api.py

@@ -3,15 +3,19 @@
 # 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,
 )
 from datadog_api_client.v1.model.notebooks_response import NotebooksResponse
+from datadog_api_client.v1.model.notebooks_response_data import NotebooksResponseData
 from datadog_api_client.v1.model.notebook_response import NotebookResponse
 from datadog_api_client.v1.model.notebook_create_request import NotebookCreateRequest
 from datadog_api_client.v1.model.notebook_update_request import NotebookUpdateRequest
@@ -313,6 +317,91 @@ def list_notebooks(
 
         return self._list_notebooks_endpoint.call_with_http_info(**kwargs)
 
+    def list_notebooks_with_pagination(
+        self,
+        *,
+        author_handle: Union[str, UnsetType] = unset,
+        exclude_author_handle: Union[str, UnsetType] = unset,
+        start: Union[int, UnsetType] = unset,
+        count: Union[int, UnsetType] = unset,
+        sort_field: Union[str, UnsetType] = unset,
+        sort_dir: Union[str, UnsetType] = unset,
+        query: Union[str, UnsetType] = unset,
+        include_cells: Union[bool, UnsetType] = unset,
+        is_template: Union[bool, UnsetType] = unset,
+        type: Union[str, UnsetType] = unset,
+    ) -> collections.abc.Iterable[NotebooksResponseData]:
+        """Get all notebooks.
+
+        Provide a paginated version of :meth:`list_notebooks`, returning all items.
+
+        :param author_handle: Return notebooks created by the given ``author_handle``.
+        :type author_handle: str, optional
+        :param exclude_author_handle: Return notebooks not created by the given ``author_handle``.
+        :type exclude_author_handle: str, optional
+        :param start: The index of the first notebook you want returned.
+        :type start: int, optional
+        :param count: The number of notebooks to be returned.
+        :type count: int, optional
+        :param sort_field: Sort by field ``modified`` , ``name`` , or ``created``.
+        :type sort_field: str, optional
+        :param sort_dir: Sort by direction ``asc`` or ``desc``.
+        :type sort_dir: str, optional
+        :param query: Return only notebooks with ``query`` string in notebook name or author handle.
+        :type query: str, optional
+        :param include_cells: Value of ``false`` excludes the ``cells`` and global ``time`` for each notebook.
+        :type include_cells: bool, optional
+        :param is_template: True value returns only template notebooks. Default is false (returns only non-template notebooks).
+        :type is_template: bool, optional
+        :param type: If type is provided, returns only notebooks with that metadata type. Default does not have type filtering.
+        :type type: str, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[NotebooksResponseData]
+        """
+        kwargs: Dict[str, Any] = {}
+        if author_handle is not unset:
+            kwargs["author_handle"] = author_handle
+
+        if exclude_author_handle is not unset:
+            kwargs["exclude_author_handle"] = exclude_author_handle
+
+        if start is not unset:
+            kwargs["start"] = start
+
+        if count is not unset:
+            kwargs["count"] = count
+
+        if sort_field is not unset:
+            kwargs["sort_field"] = sort_field
+
+        if sort_dir is not unset:
+            kwargs["sort_dir"] = sort_dir
+
+        if query is not unset:
+            kwargs["query"] = query
+
+        if include_cells is not unset:
+            kwargs["include_cells"] = include_cells
+
+        if is_template is not unset:
+            kwargs["is_template"] = is_template
+
+        if type is not unset:
+            kwargs["type"] = type
+
+        local_page_size = get_attribute_from_path(kwargs, "count", 100)
+        endpoint = self._list_notebooks_endpoint
+        set_attribute_from_path(kwargs, "count", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "data",
+            "page_offset_param": "start",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def update_notebook(
         self,
         notebook_id: int,

tests/v1/cassettes/test_scenarios/test_get_all_notebooks_returns_ok_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-08-31T09:47:14.068Z

tests/v1/cassettes/test_scenarios/test_get_all_notebooks_returns_ok_response_with_pagination.yaml

@@ -0,0 +1,69 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/notebooks?count=2
+  response:
+    body:
+      string: '{"data":[{"type":"notebooks","id":4758632,"attributes":{"name":"PCF
+        Container Usage Attribution","cells":[{"type":"notebook_cells","id":"jod8dstf","attributes":{"split_by":{"tags":[],"keys":[]},"definition":{"title":"Count
+        of containers","type":"query_table","requests":[{"response_format":"scalar","formulas":[{"alias":"containers","formula":"query1","limit":{"count":10000,"order":"desc"}}],"queries":[{"name":"query1","data_source":"metrics","query":"avg:cloudfoundry.nozzle.app.instances{$container_deployement_guid,$troux_uuid}
+        by {app_name,bosh_id}","aggregator":"avg"}]}]},"graph_size":"m","time":null}},{"type":"notebook_cells","id":"0t3xetbt","attributes":{"definition":{"type":"markdown","text":"This
+        displays the count of containers per `troux_uuid` (`bosh_id`) and `container_deployment_guid`
+        (`app_name`)"}}},{"type":"notebook_cells","id":"7lxv9snf","attributes":{"definition":{"title":"Percentage
+        breakdown of containers on VMs","requests":[{"response_format":"scalar","formulas":[{"formula":"query1","limit":{"order":"desc"}}],"queries":[{"query":"avg:cloudfoundry.nozzle.app.instances{$troux_uuid,$container_deployement_guid}
+        by {app_name,bosh_id}.rollup(avg, 3600)","data_source":"metrics","name":"query1","aggregator":"sum"}],"style":{"palette":"datadog16"}}],"type":"sunburst","legend":{"type":"automatic"}},"time":null}},{"type":"notebook_cells","id":"uhwq9m18","attributes":{"definition":{"type":"markdown","text":"This
+        displays the count of containers per\u00a0`troux_uuid` (`bosh_id`)\u00a0and\u00a0`container_deployment_guid`
+        (`app_name`) as percentages of total containers\n"}}},{"type":"notebook_cells","id":"fcid5x88","attributes":{"split_by":{"tags":[],"keys":[]},"definition":{"title":"Number
+        of VMs per container_deployment_guid","type":"query_value","requests":[{"response_format":"scalar","queries":[{"name":"query1","data_source":"metrics","query":"avg:cloudfoundry.nozzle.app.instances{$troux_uuid,$container_deployement_guid}","aggregator":"avg"}],"formulas":[{"formula":"count_nonzero(query1)","alias":"VMs"}]}],"autoscale":true,"precision":2},"graph_size":"xs","time":null}},{"type":"notebook_cells","id":"7qmg68gc","attributes":{"definition":{"type":"markdown","text":"When
+        filtering by the template variable `container_deployment_guid`, this value
+        represents the number of VMs (or `troux_uuid`s) that `container_deployment_guid`
+        runs on "}}},{"type":"notebook_cells","id":"h75xo4j5","attributes":{"split_by":{"tags":[],"keys":[]},"definition":{"type":"query_table","requests":[{"queries":[{"data_source":"metrics","name":"query1","query":"avg:system.cpu.user{$troux_uuid,$container_deployement_guid}
+        by {bosh_id,application_name}.rollup(avg, 3600)","aggregator":"avg"}],"formulas":[{"conditional_formats":[],"cell_display_mode":"bar","formula":"query1","limit":{"count":500,"order":"desc"}}],"response_format":"scalar"}],"has_search_bar":"auto"},"time":null}}],"time":{"live_span":"2d"},"metadata":{"take_snapshots":false,"is_template":false,"is_favorite":false,"type":null},"template_variables":[{"name":"container_deployement_guid","prefix":"app_name","available_values":[],"default":"*"},{"name":"troux_uuid","prefix":"bosh_id","available_values":[],"default":"*"}],"status":"published","modified":"2023-02-27T17:53:59.623647+00:00","created":"2023-02-15T18:12:35.189588+00:00","author":{"name":"Sarah
+        Witt","handle":"[email protected]","email":"[email protected]","icon":"https://secure.gravatar.com/avatar/7f710a0bcefa8df8d47bfcba79f69a40?s=48&d=retro","title":null,"verified":true,"disabled":false,"status":"Active"}}},{"type":"notebooks","id":4823614,"attributes":{"name":"Sarah
+        Feb 22 2023 11:04","cells":[{"type":"notebook_cells","id":"dnulkt1p","attributes":{"split_by":{"tags":[],"keys":[]},"definition":{"show_legend":true,"type":"timeseries","requests":[{"response_format":"timeseries","queries":[{"name":"query1","data_source":"metrics","query":"avg:system.cpu.user{*}"}],"style":{"palette":"dog_classic","line_type":"solid","line_width":"normal"},"display_type":"line"}]},"time":null}}],"time":{"live_span":"1h"},"metadata":{"take_snapshots":false,"is_template":false,"is_favorite":false,"type":null},"template_variables":[],"status":"published","modified":"2023-02-22T16:04:51.449049+00:00","created":"2023-02-22T16:04:51.449049+00:00","author":{"name":"Sarah
+        Witt","handle":"[email protected]","email":"[email protected]","icon":"https://secure.gravatar.com/avatar/7f710a0bcefa8df8d47bfcba79f69a40?s=48&d=retro","title":null,"verified":true,"disabled":false,"status":"Active"}}}],"meta":{"page":{"total_count":158,"total_filtered_count":2}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/notebooks?count=2&start=2
+  response:
+    body:
+      string: '{"data":[{"type":"notebooks","id":4745953,"attributes":{"name":"PCF
+        Container Usage Attribution","cells":[{"type":"notebook_cells","id":"bqyp7v5p","attributes":{"definition":{"title":"Count
+        of containers","type":"query_table","requests":[{"response_format":"scalar","formulas":[{"alias":"containers","formula":"query1","limit":{"count":500,"order":"desc"}}],"queries":[{"name":"query1","data_source":"metrics","query":"avg:cloudfoundry.nozzle.app.instances{$troux_uuid,$container_deployment_guid}
+        by {app_name,bosh_id}.rollup(avg, 3600)","aggregator":"sum"}]}]},"time":null,"split_by":{"keys":[],"tags":[]},"graph_size":"m"}},{"type":"notebook_cells","id":"svgafvhk","attributes":{"definition":{"type":"markdown","text":"This
+        displays the count of containers per `troux_uuid` (`bosh_id`) and `container_deployment_guid`
+        (`app_name`)"}}},{"type":"notebook_cells","id":"vq0zsiia","attributes":{"definition":{"title":"Percentage
+        breakdown of containers on VMs","requests":[{"response_format":"scalar","formulas":[{"formula":"query1","limit":{"order":"desc"}}],"queries":[{"query":"avg:cloudfoundry.nozzle.app.instances{$troux_uuid,$container_deployment_guid}
+        by {app_name,bosh_id}.rollup(avg, 3600)","data_source":"metrics","name":"query1","aggregator":"sum"}],"style":{"palette":"datadog16"}}],"type":"sunburst","legend":{"type":"automatic"}},"time":null}},{"type":"notebook_cells","id":"oldqd75v","attributes":{"definition":{"type":"markdown","text":"This
+        displays the count of containers per\u00a0`troux_uuid` (`bosh_id`)\u00a0and\u00a0`container_deployment_guid`
+        (`app_name`) as percentages of total containers\n"}}},{"type":"notebook_cells","id":"m2dcz3jo","attributes":{"definition":{"title":"Number
+        of VMs per container_deployment_guid","type":"query_value","requests":[{"response_format":"scalar","queries":[{"name":"query1","data_source":"metrics","query":"avg:cloudfoundry.nozzle.app.instances{$troux_uuid,$container_deployment_guid}","aggregator":"avg"}],"formulas":[{"formula":"count_nonzero(query1)","alias":"VMs"}]}],"autoscale":true,"precision":2},"time":null,"split_by":{"keys":[],"tags":[]},"graph_size":"xs"}},{"type":"notebook_cells","id":"39crgjxd","attributes":{"definition":{"type":"markdown","text":"When
+        filtering by the template variable `container_deployment_guid`, this value
+        represents the number of VMs (or `troux_uuid`s) that `container_deployment_guid`
+        runs on "}}}],"time":{"live_span":"2d"},"metadata":{"take_snapshots":false,"is_template":false,"is_favorite":false,"type":null},"template_variables":[{"name":"container_deployment_guid","prefix":"app_name","available_values":[],"default":"*"},{"name":"troux_uuid","prefix":"bosh_id","available_values":[],"default":"*"}],"status":"published","modified":"2023-02-16T17:32:46.774359+00:00","created":"2023-02-14T20:04:16.789408+00:00","author":{"name":"Sarah
+        Witt","handle":"[email protected]","email":"[email protected]","icon":"https://secure.gravatar.com/avatar/7f710a0bcefa8df8d47bfcba79f69a40?s=48&d=retro","title":null,"verified":true,"disabled":false,"status":"Active"}}}],"meta":{"page":{"total_count":158,"total_filtered_count":2}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/notebooks.feature

@@ -86,6 +86,14 @@ Feature: Notebooks
     Then the response status is 200 OK
     And the response "data" has item with field "attributes.status" with value "published"
 
+  @replay-only @skip-validation @team:DataDog/notebooks @with-pagination
+  Scenario: Get all notebooks returns "OK" response with pagination
+    Given new "ListNotebooks" request
+    And request contains "count" parameter with value 2
+    When the request with pagination is sent
+    Then the response status is 200 OK
+    And the response has 3 items
+
   @generated @skip @team:DataDog/notebooks
   Scenario: Update a notebook returns "Bad Request" response
     Given new "UpdateNotebook" request