Add pagination extension to SLOs (#1632)

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-08-28 20:29:20.630970",
-            "spec_repo_commit": "0fac706f"
+            "regenerated": "2023-08-30 07:29:22.537461",
+            "spec_repo_commit": "febdee32"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-28 20:29:20.644178",
-            "spec_repo_commit": "0fac706f"
+            "regenerated": "2023-08-30 07:29:22.557428",
+            "spec_repo_commit": "febdee32"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -27004,6 +27004,7 @@ paths:
         name: limit
         required: false
         schema:
+          default: 1000
           format: int64
           type: integer
       - description: The specific offset to use as the beginning of the returned response.
@@ -27048,6 +27049,10 @@ paths:
       summary: Get all SLOs
       tags:
       - Service Level Objectives
+      x-pagination:
+        limitParam: limit
+        pageOffsetParam: offset
+        resultsPath: data
     post:
       description: Create a service level objective object.
       operationId: CreateSLO

examples/v1/service-level-objectives/ListSLOs_3036942817.py

@@ -0,0 +1,15 @@
+"""
+Get all SLOs returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.service_level_objectives_api import ServiceLevelObjectivesApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ServiceLevelObjectivesApi(api_client)
+    items = api_instance.list_slos_with_pagination(
+        limit=2,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v1/api/service_level_objectives_api.py

@@ -3,23 +3,26 @@
 # 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.slo_list_response import SLOListResponse
+from datadog_api_client.v1.model.service_level_objective import ServiceLevelObjective
 from datadog_api_client.v1.model.service_level_objective_request import ServiceLevelObjectiveRequest
 from datadog_api_client.v1.model.slo_bulk_delete_response import SLOBulkDeleteResponse
 from datadog_api_client.v1.model.slo_bulk_delete import SLOBulkDelete
 from datadog_api_client.v1.model.check_can_delete_slo_response import CheckCanDeleteSLOResponse
 from datadog_api_client.v1.model.search_slo_response import SearchSLOResponse
 from datadog_api_client.v1.model.slo_delete_response import SLODeleteResponse
 from datadog_api_client.v1.model.slo_response import SLOResponse
-from datadog_api_client.v1.model.service_level_objective import ServiceLevelObjective
 from datadog_api_client.v1.model.slo_correction_list_response import SLOCorrectionListResponse
 from datadog_api_client.v1.model.slo_history_response import SLOHistoryResponse
 
@@ -561,6 +564,67 @@ def list_slos(
 
         return self._list_slos_endpoint.call_with_http_info(**kwargs)
 
+    def list_slos_with_pagination(
+        self,
+        *,
+        ids: Union[str, UnsetType] = unset,
+        query: Union[str, UnsetType] = unset,
+        tags_query: Union[str, UnsetType] = unset,
+        metrics_query: Union[str, UnsetType] = unset,
+        limit: Union[int, UnsetType] = unset,
+        offset: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[ServiceLevelObjective]:
+        """Get all SLOs.
+
+        Provide a paginated version of :meth:`list_slos`, returning all items.
+
+        :param ids: A comma separated list of the IDs of the service level objectives objects.
+        :type ids: str, optional
+        :param query: The query string to filter results based on SLO names.
+        :type query: str, optional
+        :param tags_query: The query string to filter results based on a single SLO tag.
+        :type tags_query: str, optional
+        :param metrics_query: The query string to filter results based on SLO numerator and denominator.
+        :type metrics_query: str, optional
+        :param limit: The number of SLOs to return in the response.
+        :type limit: int, optional
+        :param offset: The specific offset to use as the beginning of the returned response.
+        :type offset: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[ServiceLevelObjective]
+        """
+        kwargs: Dict[str, Any] = {}
+        if ids is not unset:
+            kwargs["ids"] = ids
+
+        if query is not unset:
+            kwargs["query"] = query
+
+        if tags_query is not unset:
+            kwargs["tags_query"] = tags_query
+
+        if metrics_query is not unset:
+            kwargs["metrics_query"] = metrics_query
+
+        if limit is not unset:
+            kwargs["limit"] = limit
+
+        if offset is not unset:
+            kwargs["offset"] = offset
+
+        local_page_size = get_attribute_from_path(kwargs, "limit", 1000)
+        endpoint = self._list_slos_endpoint
+        set_attribute_from_path(kwargs, "limit", local_page_size, endpoint.params_map)
+        pagination = {
+            "limit_value": local_page_size,
+            "results_path": "data",
+            "page_offset_param": "offset",
+            "endpoint": endpoint,
+            "kwargs": kwargs,
+        }
+        return endpoint.call_with_http_info_paginated(pagination)
+
     def search_slo(
         self,
         *,

tests/v1/cassettes/test_scenarios/test_get_all_slos_returns_ok_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-08-25T12:33:42.432Z

tests/v1/cassettes/test_scenarios/test_get_all_slos_returns_ok_response_with_pagination.yaml

@@ -0,0 +1,43 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/slo?limit=2
+  response:
+    body:
+      string: '{"data":[{"id":"70e82706f4ae56ff8bdd7f02e767f97c","name":"test SLO
+        1668426861","tags":["type:test"],"monitor_tags":[],"thresholds":[{"timeframe":"7d","target":90.0,"target_display":"90."}],"type":"metric","type_id":1,"description":"","timeframe":"7d","target_threshold":90.0,"query":{"denominator":"sum:my.custom.metric{!type:ignored}.as_count()","numerator":"sum:my.custom.metric{type:good,!type:ignored}.as_count()"},"creator":{"name":null,"handle":"[email protected]","email":"[email protected]"},"created_at":1668426862,"modified_at":1668426862},{"id":"955ab6301fa656e7b061de4a05ad4774","name":"tf-TestAccDatadogServiceLevelObjective_Basic-local-1673543942-updated","tags":["foo:bar","baz"],"monitor_tags":[],"thresholds":[{"timeframe":"7d","target":99.5,"target_display":"99.5","warning":99.8,"warning_display":"99.8"},{"timeframe":"30d","target":98.0,"target_display":"98.","warning":99.0,"warning_display":"99."},{"timeframe":"90d","target":99.9,"target_display":"99.9"}],"type":"metric","type_id":1,"description":"some
+        updated description about foo SLO","timeframe":"7d","warning_threshold":99.8,"target_threshold":99.5,"query":{"denominator":"sum:my.metric{type:good}.as_count()
+        + sum:my.metric{type:bad}.as_count()","numerator":"sum:my.metric{type:good}.as_count()"},"creator":{"name":null,"handle":"[email protected]","email":"[email protected]"},"created_at":1673543944,"modified_at":1673543945}],"error":null,"metadata":{"page":{"total_count":3,"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/slo?limit=2&offset=2
+  response:
+    body:
+      string: '{"data":[{"id":"a17acfd48b7c55d19192e3a697cc1d01","name":"test SLO
+        1677686870","tags":[],"monitor_tags":[],"thresholds":[{"timeframe":"7d","target":90.0,"target_display":"90."}],"type":"monitor","type_id":0,"description":"","timeframe":"7d","target_threshold":90.0,"monitor_ids":[112445445],"creator":{"name":"CI
+        Account","handle":"9919ec9b-ebc7-49ee-8dc8-03626e717cca","email":"[email protected]"},"created_at":1677686871,"modified_at":1677686871}],"error":null,"metadata":{"page":{"total_count":3,"total_filtered_count":2}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/service_level_objectives.feature

@@ -134,6 +134,14 @@ Feature: Service Level Objectives
     And the response "data" has length 1
     And the response "data[0].id" has the same value as "slo.data[0].id"
 
+  @replay-only @skip-validation @team:DataDog/slo-app @with-pagination
+  Scenario: Get all SLOs returns "OK" response with pagination
+    Given new "ListSLOs" request
+    And request contains "limit" 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/slo-app
   Scenario: Get an SLO's details returns "Not found" response
     Given new "GetSLO" request