Powerpack pagination and test fixes

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-10 13:47:40.326078",
-            "spec_repo_commit": "afb48804"
+            "regenerated": "2023-10-12 13:31:21.743085",
+            "spec_repo_commit": "6653b14d"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2023-10-10 13:47:40.346011",
-            "spec_repo_commit": "afb48804"
+            "regenerated": "2023-10-12 13:31:21.760452",
+            "spec_repo_commit": "6653b14d"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -23874,6 +23874,18 @@ paths:
     get:
       description: Get a list of all powerpacks.
       operationId: ListPowerpacks
+      parameters:
+      - description: Maximum number of powerpacks in the response.
+        example: 25
+        in: query
+        name: page[limit]
+        required: false
+        schema:
+          default: 25
+          format: int64
+          maximum: 1000
+          type: integer
+      - $ref: '#/components/parameters/PageOffset'
       responses:
         '200':
           content:
@@ -23891,6 +23903,10 @@ paths:
       summary: Get all powerpacks
       tags:
       - Powerpack
+      x-pagination:
+        limitParam: page[limit]
+        pageOffsetParam: page[offset]
+        resultsPath: data
     post:
       description: Create a powerpack.
       operationId: CreatePowerpack

examples/v2/powerpack/CreatePowerpack.java

@@ -48,7 +48,7 @@ public static void main(String[] args) {
                                             .width(12L)
                                             .x(0L)
                                             .y(0L)))
-                            .name("Sample Powerpack")
+                            .name("Example-Powerpack")
                             .tags(Collections.singletonList("tag:sample"))
                             .templateVariables(
                                 Collections.singletonList(

examples/v2/powerpack/ListPowerpacks.java

@@ -3,6 +3,7 @@
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.ApiException;
 import com.datadog.api.client.v2.api.PowerpackApi;
+import com.datadog.api.client.v2.api.PowerpackApi.ListPowerpacksOptionalParameters;
 import com.datadog.api.client.v2.model.ListPowerpacksResponse;
 
 public class Example {
@@ -11,7 +12,8 @@ public static void main(String[] args) {
     PowerpackApi apiInstance = new PowerpackApi(defaultClient);
 
     try {
-      ListPowerpacksResponse result = apiInstance.listPowerpacks();
+      ListPowerpacksResponse result =
+          apiInstance.listPowerpacks(new ListPowerpacksOptionalParameters().pageLimit(1000L));
       System.out.println(result);
     } catch (ApiException e) {
       System.err.println("Exception when calling PowerpackApi#listPowerpacks");

examples/v2/powerpack/ListPowerpacks_1173755071.java

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

examples/v2/powerpack/UpdatePowerpack.java

@@ -51,7 +51,7 @@ public static void main(String[] args) {
                                             .width(12L)
                                             .x(0L)
                                             .y(0L)))
-                            .name("Sample Powerpack")
+                            .name("Example-Powerpack")
                             .tags(Collections.singletonList("tag:sample"))
                             .templateVariables(
                                 Collections.singletonList(

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

@@ -3,14 +3,18 @@
 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.ListPowerpacksResponse;
 import com.datadog.api.client.v2.model.Powerpack;
+import com.datadog.api.client.v2.model.PowerpackData;
 import com.datadog.api.client.v2.model.PowerpackResponse;
 import jakarta.ws.rs.client.Invocation;
 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;
 
@@ -444,6 +448,35 @@ public CompletableFuture<ApiResponse<PowerpackResponse>> getPowerpackWithHttpInf
         new GenericType<PowerpackResponse>() {});
   }
 
+  /** Manage optional parameters to listPowerpacks. */
+  public static class ListPowerpacksOptionalParameters {
+    private Long pageLimit;
+    private Long pageOffset;
+
+    /**
+     * Set pageLimit.
+     *
+     * @param pageLimit Maximum number of powerpacks in the response. (optional, default to 25)
+     * @return ListPowerpacksOptionalParameters
+     */
+    public ListPowerpacksOptionalParameters pageLimit(Long pageLimit) {
+      this.pageLimit = pageLimit;
+      return this;
+    }
+
+    /**
+     * Set pageOffset.
+     *
+     * @param pageOffset Specific offset to use as the beginning of the returned page. (optional,
+     *     default to 0)
+     * @return ListPowerpacksOptionalParameters
+     */
+    public ListPowerpacksOptionalParameters pageOffset(Long pageOffset) {
+      this.pageOffset = pageOffset;
+      return this;
+    }
+  }
+
   /**
    * Get all powerpacks.
    *
@@ -453,7 +486,7 @@ public CompletableFuture<ApiResponse<PowerpackResponse>> getPowerpackWithHttpInf
    * @throws ApiException if fails to make API call
    */
   public ListPowerpacksResponse listPowerpacks() throws ApiException {
-    return listPowerpacksWithHttpInfo().getData();
+    return listPowerpacksWithHttpInfo(new ListPowerpacksOptionalParameters()).getData();
   }
 
   /**
@@ -464,16 +497,100 @@ public ListPowerpacksResponse listPowerpacks() throws ApiException {
    * @return CompletableFuture&lt;ListPowerpacksResponse&gt;
    */
   public CompletableFuture<ListPowerpacksResponse> listPowerpacksAsync() {
-    return listPowerpacksWithHttpInfoAsync()
+    return listPowerpacksWithHttpInfoAsync(new ListPowerpacksOptionalParameters())
+        .thenApply(
+            response -> {
+              return response.getData();
+            });
+  }
+
+  /**
+   * Get all powerpacks.
+   *
+   * <p>See {@link #listPowerpacksWithHttpInfo}.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return ListPowerpacksResponse
+   * @throws ApiException if fails to make API call
+   */
+  public ListPowerpacksResponse listPowerpacks(ListPowerpacksOptionalParameters parameters)
+      throws ApiException {
+    return listPowerpacksWithHttpInfo(parameters).getData();
+  }
+
+  /**
+   * Get all powerpacks.
+   *
+   * <p>See {@link #listPowerpacksWithHttpInfoAsync}.
+   *
+   * @param parameters Optional parameters for the request.
+   * @return CompletableFuture&lt;ListPowerpacksResponse&gt;
+   */
+  public CompletableFuture<ListPowerpacksResponse> listPowerpacksAsync(
+      ListPowerpacksOptionalParameters parameters) {
+    return listPowerpacksWithHttpInfoAsync(parameters)
         .thenApply(
             response -> {
               return response.getData();
             });
   }
 
+  /**
+   * Get all powerpacks.
+   *
+   * <p>See {@link #listPowerpacksWithHttpInfo}.
+   *
+   * @return PaginationIterable&lt;PowerpackData&gt;
+   */
+  public PaginationIterable<PowerpackData> listPowerpacksWithPagination() {
+    ListPowerpacksOptionalParameters parameters = new ListPowerpacksOptionalParameters();
+    return listPowerpacksWithPagination(parameters);
+  }
+
+  /**
+   * Get all powerpacks.
+   *
+   * <p>See {@link #listPowerpacksWithHttpInfo}.
+   *
+   * @return ListPowerpacksResponse
+   */
+  public PaginationIterable<PowerpackData> listPowerpacksWithPagination(
+      ListPowerpacksOptionalParameters parameters) {
+    String resultsPath = "getData";
+    String valueGetterPath = "";
+    String valueSetterPath = "pageOffset";
+    Boolean valueSetterParamOptional = true;
+    Long limit;
+
+    if (parameters.pageLimit == null) {
+      limit = 25l;
+      parameters.pageLimit(limit);
+    } else {
+      limit = parameters.pageLimit;
+    }
+
+    LinkedHashMap<String, Object> args = new LinkedHashMap<String, Object>();
+    args.put("optionalParams", parameters);
+
+    PaginationIterable iterator =
+        new PaginationIterable(
+            this,
+            "listPowerpacks",
+            resultsPath,
+            valueGetterPath,
+            valueSetterPath,
+            valueSetterParamOptional,
+            true,
+            limit,
+            args);
+
+    return iterator;
+  }
+
   /**
    * Get a list of all powerpacks.
    *
+   * @param parameters Optional parameters for the request.
    * @return ApiResponse&lt;ListPowerpacksResponse&gt;
    * @throws ApiException if fails to make API call
    * @http.response.details
@@ -484,18 +601,25 @@ public CompletableFuture<ListPowerpacksResponse> listPowerpacksAsync() {
    *       <tr><td> 429 </td><td> Too many requests </td><td>  -  </td></tr>
    *     </table>
    */
-  public ApiResponse<ListPowerpacksResponse> listPowerpacksWithHttpInfo() throws ApiException {
+  public ApiResponse<ListPowerpacksResponse> listPowerpacksWithHttpInfo(
+      ListPowerpacksOptionalParameters parameters) throws ApiException {
     Object localVarPostBody = null;
+    Long pageLimit = parameters.pageLimit;
+    Long pageOffset = parameters.pageOffset;
     // create path and map variables
     String localVarPath = "/api/v2/powerpacks";
 
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[limit]", pageLimit));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[offset]", pageOffset));
+
     Invocation.Builder builder =
         apiClient.createBuilder(
             "v2.PowerpackApi.listPowerpacks",
             localVarPath,
-            new ArrayList<Pair>(),
+            localVarQueryParams,
             localVarHeaderParams,
             new HashMap<String, String>(),
             new String[] {"application/json"},
@@ -516,22 +640,30 @@ public ApiResponse<ListPowerpacksResponse> listPowerpacksWithHttpInfo() throws A
    *
    * <p>See {@link #listPowerpacksWithHttpInfo}.
    *
+   * @param parameters Optional parameters for the request.
    * @return CompletableFuture&lt;ApiResponse&lt;ListPowerpacksResponse&gt;&gt;
    */
-  public CompletableFuture<ApiResponse<ListPowerpacksResponse>> listPowerpacksWithHttpInfoAsync() {
+  public CompletableFuture<ApiResponse<ListPowerpacksResponse>> listPowerpacksWithHttpInfoAsync(
+      ListPowerpacksOptionalParameters parameters) {
     Object localVarPostBody = null;
+    Long pageLimit = parameters.pageLimit;
+    Long pageOffset = parameters.pageOffset;
     // create path and map variables
     String localVarPath = "/api/v2/powerpacks";
 
+    List<Pair> localVarQueryParams = new ArrayList<Pair>();
     Map<String, String> localVarHeaderParams = new HashMap<String, String>();
 
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[limit]", pageLimit));
+    localVarQueryParams.addAll(apiClient.parameterToPairs("", "page[offset]", pageOffset));
+
     Invocation.Builder builder;
     try {
       builder =
           apiClient.createBuilder(
               "v2.PowerpackApi.listPowerpacks",
               localVarPath,
-              new ArrayList<Pair>(),
+              localVarQueryParams,
               localVarHeaderParams,
               new HashMap<String, String>(),
               new String[] {"application/json"},

src/test/java/com/datadog/api/ClientSteps.java

@@ -338,16 +338,16 @@ public void theResponseHasItemWithField(String responsePath, String keyPath, Str
       responseList = (List) responseObject.getActualInstance();
     }
     for (Object responseItem : responseList) {
-      Object itemValue = World.lookup(responseItem, keyPath);
       try {
+        Object itemValue = World.lookup(responseItem, keyPath);
         assertEquals(
             World.fromJSON(
                 world.getObjectMapper(),
                 itemValue.getClass(),
                 World.templated(value, world.context)),
             itemValue);
         return;
-      } catch (AssertionError e) {
+      } catch (AssertionError | NullPointerException e) {
         continue;
       }
     }

src/test/resources/cassettes/features/v1/Create_a_new_dashboard_with_powerpack_widget.freeze

@@ -1 +1 @@
-2023-09-26T21:29:30.230Z
+2023-10-11T18:44:47.026Z