Add pagination extension to SLO corrections (#1631)

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-23 20:02:20.233538",
-            "spec_repo_commit": "7e4a4121"
+            "regenerated": "2023-08-25 12:25:40.724264",
+            "spec_repo_commit": "1a77c0b6"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-08-23 20:02:20.251225",
-            "spec_repo_commit": "7e4a4121"
+            "regenerated": "2023-08-25 12:25:40.743585",
+            "spec_repo_commit": "1a77c0b6"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -27185,6 +27185,7 @@ paths:
         name: limit
         required: false
         schema:
+          default: 25
           format: int64
           type: integer
       responses:
@@ -27210,6 +27211,10 @@ paths:
       summary: Get all SLO corrections
       tags:
       - Service Level Objective Corrections
+      x-pagination:
+        limitParam: limit
+        pageOffsetParam: offset
+        resultsPath: data
     post:
       description: Create an SLO Correction.
       operationId: CreateSLOCorrection

examples/v1/service-level-objective-corrections/ListSLOCorrection_2647266873.py

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

src/datadog_api_client/v1/api/service_level_objective_corrections_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.slo_correction_list_response import SLOCorrectionListResponse
+from datadog_api_client.v1.model.slo_correction import SLOCorrection
 from datadog_api_client.v1.model.slo_correction_response import SLOCorrectionResponse
 from datadog_api_client.v1.model.slo_correction_create_request import SLOCorrectionCreateRequest
 from datadog_api_client.v1.model.slo_correction_update_request import SLOCorrectionUpdateRequest
@@ -225,6 +229,43 @@ def list_slo_correction(
 
         return self._list_slo_correction_endpoint.call_with_http_info(**kwargs)
 
+    def list_slo_correction_with_pagination(
+        self,
+        *,
+        offset: Union[int, UnsetType] = unset,
+        limit: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[SLOCorrection]:
+        """Get all SLO corrections.
+
+        Provide a paginated version of :meth:`list_slo_correction`, returning all items.
+
+        :param offset: The specific offset to use as the beginning of the returned response.
+        :type offset: int, optional
+        :param limit: The number of SLO corrections to return in the response. Default is 25.
+        :type limit: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[SLOCorrection]
+        """
+        kwargs: Dict[str, Any] = {}
+        if offset is not unset:
+            kwargs["offset"] = offset
+
+        if limit is not unset:
+            kwargs["limit"] = limit
+
+        local_page_size = get_attribute_from_path(kwargs, "limit", 25)
+        endpoint = self._list_slo_correction_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 update_slo_correction(
         self,
         slo_correction_id: str,

tests/v1/cassettes/test_scenarios/test_get_all_slo_corrections_returns_ok_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-08-25T11:50:34.970Z

tests/v1/cassettes/test_scenarios/test_get_all_slo_corrections_returns_ok_response_with_pagination.yaml

@@ -0,0 +1,41 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v1/slo/correction?limit=2
+  response:
+    body:
+      string: '{"data":[{"type":"correction","id":"fb76e0fa-bf7b-11ed-ba7e-da7ad0902002","attributes":{"slo_id":"a17acfd48b7c55d19192e3a697cc1d01","start":1678255200,"end":1678355280,"description":"","category":"Other","timezone":"UTC","created_at":1678477473,"modified_at":1678477473,"rrule":null,"duration":null,"creator":{"data":{"type":"users","id":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","attributes":{"uuid":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","handle":"support-nickautotestingorg","email":"[email protected]","name":"Datadog
+        Support","icon":"https://secure.gravatar.com/avatar/e6952b5f29fe2d996cf4e63f40db9e71?s=48&d=retro"}}},"modifier":null}},{"type":"correction","id":"2d16c2ee-bf70-11ed-895f-da7ad0902002","attributes":{"slo_id":"70e82706f4ae56ff8bdd7f02e767f97c","start":1678255200,"end":1678339140,"description":"","category":"Other","timezone":"UTC","created_at":1678472403,"modified_at":1678472403,"rrule":null,"duration":null,"creator":{"data":{"type":"users","id":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","attributes":{"uuid":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","handle":"support-nickautotestingorg","email":"[email protected]","name":"Datadog
+        Support","icon":"https://secure.gravatar.com/avatar/e6952b5f29fe2d996cf4e63f40db9e71?s=48&d=retro"}}},"modifier":null}}],"meta":{"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/correction?limit=2&offset=2
+  response:
+    body:
+      string: '{"data":[{"type":"correction","id":"cc2316d2-bf6e-11ed-82f2-da7ad0902002","attributes":{"slo_id":"955ab6301fa656e7b061de4a05ad4774","start":1678255200,"end":1678339140,"description":"","category":"Other","timezone":"UTC","created_at":1678471811,"modified_at":1678471811,"rrule":null,"duration":null,"creator":{"data":{"type":"users","id":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","attributes":{"uuid":"35c75d43-eba0-11e9-a77a-2b3585ff5dfb","handle":"support-nickautotestingorg","email":"[email protected]","name":"Datadog
+        Support","icon":"https://secure.gravatar.com/avatar/e6952b5f29fe2d996cf4e63f40db9e71?s=48&d=retro"}}},"modifier":null}}],"meta":{"page":{"total_count":3,"total_filtered_count":1}}}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v1/features/service_level_objective_corrections.feature

@@ -72,6 +72,14 @@ Feature: Service Level Objective Corrections
     Then the response status is 200 OK
     And the response "data" has length 1
 
+  @replay-only @skip-validation @team:DataDog/slo-app @with-pagination
+  Scenario: Get all SLO corrections returns "OK" response with pagination
+    Given new "ListSLOCorrection" 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 correction for an SLO returns "Bad Request" response
     Given new "GetSLOCorrection" request