Add pagination support for the GET service_definitions endpoint (#1403)

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.4",
-            "regenerated": "2023-04-06 14:03:50.942790",
-            "spec_repo_commit": "9572acd2"
+            "regenerated": "2023-04-06 15:04:06.579964",
+            "spec_repo_commit": "b180cceb"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2023-04-06 14:03:50.955323",
-            "spec_repo_commit": "9572acd2"
+            "regenerated": "2023-04-06 15:04:06.599309",
+            "spec_repo_commit": "b180cceb"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -21758,6 +21758,9 @@ paths:
       description: Get a list of all service definitions from the Datadog Service
         Catalog.
       operationId: ListServiceDefinitions
+      parameters:
+      - $ref: '#/components/parameters/PageSize'
+      - $ref: '#/components/parameters/PageNumber'
       responses:
         '200':
           content:
@@ -21772,6 +21775,10 @@ paths:
       summary: Get all service definitions
       tags:
       - Service Definition
+      x-pagination:
+        limitParam: page[size]
+        pageOffsetParam: page[number]
+        resultsPath: data
     post:
       description: Create or update service definition in the Datadog Service Catalog.
       operationId: CreateOrUpdateServiceDefinitions

examples/v2/service-definition/ListServiceDefinitions_336468013.py

@@ -0,0 +1,15 @@
+"""
+Get all service definitions returns "OK" response with pagination
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v2.api.service_definition_api import ServiceDefinitionApi
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = ServiceDefinitionApi(api_client)
+    items = api_instance.list_service_definitions_with_pagination(
+        page_size=2,
+    )
+    for item in items:
+        print(item)

src/datadog_api_client/v2/api/service_definition_api.py

@@ -3,11 +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.v2.model.service_definitions_list_response import ServiceDefinitionsListResponse
+from datadog_api_client.v2.model.service_definition_data import ServiceDefinitionData
 from datadog_api_client.v2.model.service_definition_create_response import ServiceDefinitionCreateResponse
 from datadog_api_client.v2.model.service_definitions_create_request import ServiceDefinitionsCreateRequest
 from datadog_api_client.v2.model.service_definition_v2_dot1 import ServiceDefinitionV2Dot1
@@ -106,7 +114,18 @@ def __init__(self, api_client=None):
                 "version": "v2",
                 "servers": None,
             },
-            params_map={},
+            params_map={
+                "page_size": {
+                    "openapi_types": (int,),
+                    "attribute": "page[size]",
+                    "location": "query",
+                },
+                "page_number": {
+                    "openapi_types": (int,),
+                    "attribute": "page[number]",
+                    "location": "query",
+                },
+            },
             headers_map={
                 "accept": ["application/json"],
                 "content_type": [],
@@ -167,12 +186,66 @@ def get_service_definition(
 
     def list_service_definitions(
         self,
+        *,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
     ) -> ServiceDefinitionsListResponse:
         """Get all service definitions.
 
         Get a list of all service definitions from the Datadog Service Catalog.
 
+        :param page_size: Size for a given page. The maximum allowed value is 5000.
+        :type page_size: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
         :rtype: ServiceDefinitionsListResponse
         """
         kwargs: Dict[str, Any] = {}
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
+
         return self._list_service_definitions_endpoint.call_with_http_info(**kwargs)
+
+    def list_service_definitions_with_pagination(
+        self,
+        *,
+        page_size: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
+    ) -> collections.abc.Iterable[ServiceDefinitionData]:
+        """Get all service definitions.
+
+        Provide a paginated version of :meth:`list_service_definitions`, returning all items.
+
+        :param page_size: Size for a given page. The maximum allowed value is 5000.
+        :type page_size: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
+
+        :return: A generator of paginated results.
+        :rtype: collections.abc.Iterable[ServiceDefinitionData]
+        """
+        kwargs: Dict[str, Any] = {}
+        if page_size is not unset:
+            kwargs["page_size"] = page_size
+
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
+
+        local_page_size = get_attribute_from_path(kwargs, "page_size", 10)
+        endpoint = self._list_service_definitions_endpoint
+        set_attribute_from_path(kwargs, "page_size", local_page_size, endpoint.params_map)
+        while True:
+            response = endpoint.call_with_http_info(**kwargs)
+            for item in get_attribute_from_path(response, "data"):
+                yield item
+            if len(get_attribute_from_path(response, "data")) < local_page_size:
+                break
+            set_attribute_from_path(
+                kwargs,
+                "page_number",
+                get_attribute_from_path(kwargs, "page_number", 0) + local_page_size,
+                endpoint.params_map,
+            )

tests/v2/cassettes/test_scenarios/test_get_all_service_definitions_returns_ok_response_with_pagination.frozen

@@ -0,0 +1 @@
+2023-04-05T09:45:34.876Z

tests/v2/cassettes/test_scenarios/test_get_all_service_definitions_returns_ok_response_with_pagination.yaml

@@ -0,0 +1,49 @@
+interactions:
+- request:
+    body: null
+    headers:
+      accept:
+      - application/json
+    method: GET
+    uri: https://api.datadoghq.com/api/v2/services/definitions?page%5Bsize%5D=2
+  response:
+    body:
+      string: '{"data":[{"type":"service-definition","id":"000c4db9ae43787066748b39ad1c3059","attributes":{"meta":{"last-modified-time":"2023-04-03T20:23:00Z","github-html-url":"","ingestion-source":"api","origin":"unknown","origin-detail":"","warnings":[],"ingested-schema-version":"v2.1"},"schema":{"schema-version":"v2.1","dd-service":"service-examplecreateorupdateservicedefinitionusingschemav21returnscreatedresponse1680553380","team":"my-team","contacts":[{"name":"Team
+        Email","type":"email","contact":"[email protected]"}],"links":[{"name":"Architecture","type":"doc","provider":"Gigoogle
+        drivetHub","url":"https://my-runbook"},{"name":"Runbook","type":"runbook","url":"https://my-runbook"},{"name":"Source
+        Code","type":"repo","provider":"GitHub","url":"https://github.com/DataDog/schema"}],"tags":["my:tag","service:tag"],"integrations":{"pagerduty":{"service-url":"https://my-org.pagerduty.com/service-directory/PMyService"},"opsgenie":{"service-url":"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000","region":"US"}},"extensions":{"myorgextension":"extensionvalue"}}}},{"type":"service-definition","id":"000c83c634df871f80ecbb47fa6b8bcc","attributes":{"meta":{"last-modified-time":"2022-11-17T02:44:15Z","github-html-url":"","ingestion-source":"api","origin":"","origin-detail":"","warnings":[],"ingested-schema-version":"v2"},"schema":{"schema-version":"v2","dd-service":"service-test-ruby-create_or_update_service_definition_returns_created_response-1668653055","dd-team":"my-team","team":"my-team","contacts":[{"name":"Team
+        Email","type":"email","contact":"[email protected]"}],"links":[{"name":"Runbook","type":"runbook","url":"https://my-runbook"}],"repos":[{"name":"Source
+        Code","provider":"GitHub","url":"https://github.com/DataDog/schema"}],"docs":[{"name":"Architecture","provider":"google
+        drive","url":"https://gdrive/mydoc"}],"tags":["my:tag","service:tag"],"integrations":{"pagerduty":"https://my-org.pagerduty.com/service-directory/PMyService","opsgenie":{"service-url":"https://my-org.opsgenie.com/service/123e4567-e89b-12d3-a456-426614174000","region":"US"}},"extensions":{"myorgextension":"extensionvalue"}}}}]}
+
+        '
+    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/v2/services/definitions?page%5Bsize%5D=2&page%5Bnumber%5D=2
+  response:
+    body:
+      string: '{"data":[{"type":"service-definition","id":"0059bcab67b74e99cc832ca503019574","attributes":{"meta":{"last-modified-time":"2023-03-02T12:21:20Z","github-html-url":"","ingestion-source":"api","origin":"dd_terraform","origin-detail":"","warnings":[{"keyword-location":"/properties/contacts/items/$ref/allOf/1/then/properties/contact/pattern","instance-location":"/contacts/0/contact","message":"does
+        not match pattern ''https://[a-zA-Z0-9_\\\\-]+.slack\\\\.com/archives/[a-zA-Z0-9_\\\\-]+''"},{"keyword-location":"/properties/contacts/items/$ref/allOf/0/then/properties/contact/format","instance-location":"/contacts/1/contact","message":"''BBB''
+        is not valid ''email''"},{"keyword-location":"/properties/contacts/items/$ref/allOf/0/then/properties/contact/format","instance-location":"/contacts/2/contact","message":"''AAA''
+        is not valid ''email''"},{"keyword-location":"/properties/contacts/items/$ref/allOf/0/then/properties/contact/format","instance-location":"/contacts/3/contact","message":"''AAA''
+        is not valid ''email''"},{"keyword-location":"/properties/contacts/items/$ref/allOf/0/then/properties/contact/format","instance-location":"/contacts/4/contact","message":"''BBB''
+        is not valid ''email''"}],"ingested-schema-version":"v2"},"schema":{"schema-version":"v2","dd-service":"tf-testaccdatadogservicedefinition_order-local-1677759678","team":"","contacts":[{"name":"AA","type":"email","contact":"AAA"},{"name":"AA","type":"slack","contact":"AAA"},{"name":"BB","type":"email","contact":"AAA"},{"name":"AA","type":"email","contact":"BBB"},{"name":"BB","type":"email","contact":"BBB"}],"links":[],"repos":[],"docs":[],"tags":["aaa","bbb"],"integrations":{},"extensions":{}}}}]}
+
+        '
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 200
+      message: OK
+version: 1

tests/v2/features/service_definition.feature

@@ -104,4 +104,12 @@ Feature: Service Definition
     Given new "ListServiceDefinitions" request
     When the request is sent
     Then the response status is 200 OK
-    And the response "data[0].attributes.meta.ingested-schema-version" is equal to "v2"
+    And the response "data[0].attributes.meta.ingestion-source" is equal to "api"
+
+  @replay-only @team:DataDog/service-catalog @with-pagination
+  Scenario: Get all service definitions returns "OK" response with pagination
+    Given new "ListServiceDefinitions" request
+    And request contains "page[size]" parameter with value 2
+    When the request with pagination is sent
+    Then the response status is 200 OK
+    And the response has 3 items