Add pagination extension to user list (#1307)

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-06 12:26:36.154836",
-            "spec_repo_commit": "07ee6775"
+            "regenerated": "2023-09-06 13:00:56.343923",
+            "spec_repo_commit": "c0d26405"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-06 12:26:36.174283",
-            "spec_repo_commit": "07ee6775"
+            "regenerated": "2023-09-06 13:00:56.357598",
+            "spec_repo_commit": "c0d26405"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -27459,6 +27459,10 @@ paths:
       tags:
       - Users
       x-codegen-request-body-name: body
+      x-pagination:
+        limitParam: page[size]
+        pageParam: page[number]
+        resultsPath: data
     post:
       description: Create a user for your organization.
       operationId: CreateUser

cassettes/v2/Users_112472755/List-all-users-returns-OK-response-with-pagination_3247448340/frozen.json

@@ -0,0 +1 @@
+"2023-09-05T13:14:24.601Z"

cassettes/v2/Users_112472755/List-all-users-returns-OK-response-with-pagination_3247448340/recording.har

@@ -0,0 +1,22 @@
+/**
+ * List all users returns "OK" response with pagination
+ */
+
+import { client, v2 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v2.UsersApi(configuration);
+
+const params: v2.UsersApiListUsersRequest = {
+  pageSize: 2,
+};
+
+(async () => {
+  try {
+    for await (const item of apiInstance.listUsersWithPagination(params)) {
+      console.log(item);
+    }
+  } catch (error) {
+    console.error(error);
+  }
+})();

examples/v2/users/ListUsers_4075885358.ts

@@ -129,6 +129,14 @@ Feature: Users
     And the response "meta.page.total_filtered_count" is equal to 1
     And the response "data[0].attributes.email" has the same value as "user.data.attributes.email"
 
+  @replay-only @skip-validation @team:DataDog/team-aaa-identity @with-pagination
+  Scenario: List all users returns "OK" response with pagination
+    Given new "ListUsers" 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
+
   @generated @skip @team:DataDog/team-aaa-identity
   Scenario: Send invitation emails returns "Bad Request" response
     Given new "SendInvitations" request

features/v2/users.feature

@@ -19,6 +19,7 @@ import { ApiException } from "../../datadog-api-client-common/exception";
 import { APIErrorResponse } from "../models/APIErrorResponse";
 import { PermissionsResponse } from "../models/PermissionsResponse";
 import { QuerySortOrder } from "../models/QuerySortOrder";
+import { User } from "../models/User";
 import { UserCreateRequest } from "../models/UserCreateRequest";
 import { UserInvitationResponse } from "../models/UserInvitationResponse";
 import { UserInvitationsRequest } from "../models/UserInvitationsRequest";
@@ -1229,6 +1230,49 @@ export class UsersApi {
     });
   }
 
+  /**
+   * Provide a paginated version of listUsers returning a generator with all the items.
+   */
+  public async *listUsersWithPagination(
+    param: UsersApiListUsersRequest = {},
+    options?: Configuration
+  ): AsyncGenerator<User> {
+    let pageSize = 10;
+    if (param.pageSize !== undefined) {
+      pageSize = param.pageSize;
+    }
+    param.pageSize = pageSize;
+    param.pageNumber = 0;
+    while (true) {
+      const requestContext = await this.requestFactory.listUsers(
+        param.pageSize,
+        param.pageNumber,
+        param.sort,
+        param.sortDir,
+        param.filter,
+        param.filterStatus,
+        options
+      );
+      const responseContext = await this.configuration.httpApi.send(
+        requestContext
+      );
+
+      const response = await this.responseProcessor.listUsers(responseContext);
+      const responseData = response.data;
+      if (responseData === undefined) {
+        break;
+      }
+      const results = responseData;
+      for (const item of results) {
+        yield item;
+      }
+      if (results.length < pageSize) {
+        break;
+      }
+      param.pageNumber = param.pageNumber + 1;
+    }
+  }
+
   /**
    * Sends emails to one or more users inviting them to join the organization.
    * @param param The request object