Add pagination extension to user list

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-06 12:26:28.379024",
-            "spec_repo_commit": "07ee6775"
+            "regenerated": "2023-09-06 13:00:56.616066",
+            "spec_repo_commit": "c0d26405"
         },
         "v2": {
             "apigentools_version": "1.6.5",
-            "regenerated": "2023-09-06 12:26:28.392536",
-            "spec_repo_commit": "07ee6775"
+            "regenerated": "2023-09-06 13:00:56.629105",
+            "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

examples/v2/users/ListUsers_4075885358.java

@@ -0,0 +1,27 @@
+// List all users returns "OK" response with pagination
+
+import com.datadog.api.client.ApiClient;
+import com.datadog.api.client.PaginationIterable;
+import com.datadog.api.client.v2.api.UsersApi;
+import com.datadog.api.client.v2.api.UsersApi.ListUsersOptionalParameters;
+import com.datadog.api.client.v2.model.User;
+
+public class Example {
+  public static void main(String[] args) {
+    ApiClient defaultClient = ApiClient.getDefaultApiClient();
+    UsersApi apiInstance = new UsersApi(defaultClient);
+
+    try {
+      PaginationIterable<User> iterable =
+          apiInstance.listUsersWithPagination(new ListUsersOptionalParameters().pageSize(2L));
+
+      for (User item : iterable) {
+        System.out.println(item);
+      }
+    } catch (RuntimeException e) {
+      System.err.println("Exception when calling UsersApi#listUsersWithPagination");
+      System.err.println("Reason: " + e.getMessage());
+      e.printStackTrace();
+    }
+  }
+}

src/main/java/com/datadog/api/client/v2/api/UsersApi.java

@@ -3,9 +3,11 @@
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.ApiException;
 import com.datadog.api.client.ApiResponse;
+import com.datadog.api.client.PaginationIterable;
 import com.datadog.api.client.Pair;
 import com.datadog.api.client.v2.model.PermissionsResponse;
 import com.datadog.api.client.v2.model.QuerySortOrder;
+import com.datadog.api.client.v2.model.User;
 import com.datadog.api.client.v2.model.UserCreateRequest;
 import com.datadog.api.client.v2.model.UserInvitationResponse;
 import com.datadog.api.client.v2.model.UserInvitationsRequest;
@@ -17,6 +19,7 @@
 import jakarta.ws.rs.core.GenericType;
 import java.util.ArrayList;
 import java.util.HashMap;
+import java.util.LinkedHashMap;
 import java.util.List;
 import java.util.Map;
 import java.util.concurrent.CompletableFuture;
@@ -995,6 +998,58 @@ public CompletableFuture<UsersResponse> listUsersAsync(ListUsersOptionalParamete
             });
   }
 
+  /**
+   * List all users.
+   *
+   * <p>See {@link #listUsersWithHttpInfo}.
+   *
+   * @return PaginationIterable&lt;User&gt;
+   */
+  public PaginationIterable<User> listUsersWithPagination() {
+    ListUsersOptionalParameters parameters = new ListUsersOptionalParameters();
+    return listUsersWithPagination(parameters);
+  }
+
+  /**
+   * List all users.
+   *
+   * <p>See {@link #listUsersWithHttpInfo}.
+   *
+   * @return UsersResponse
+   */
+  public PaginationIterable<User> listUsersWithPagination(ListUsersOptionalParameters parameters) {
+    String resultsPath = "getData";
+    String valueGetterPath = "";
+    String valueSetterPath = "pageNumber";
+    Boolean valueSetterParamOptional = true;
+    parameters.pageNumber(0l);
+    Long limit;
+
+    if (parameters.pageSize == null) {
+      limit = 10l;
+      parameters.pageSize(limit);
+    } else {
+      limit = parameters.pageSize;
+    }
+
+    LinkedHashMap<String, Object> args = new LinkedHashMap<String, Object>();
+    args.put("optionalParams", parameters);
+
+    PaginationIterable iterator =
+        new PaginationIterable(
+            this,
+            "listUsers",
+            resultsPath,
+            valueGetterPath,
+            valueSetterPath,
+            valueSetterParamOptional,
+            false,
+            limit,
+            args);
+
+    return iterator;
+  }
+
   /**
    * Get the list of all users in the organization. This list includes all users even if they are
    * deactivated or unverified.

src/test/resources/cassettes/features/v2/List_all_users_returns_OK_response_with_pagination.freeze

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

src/test/resources/com/datadog/api/client/v2/api/users.feature

@@ -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