Add pageStart extension to case management pagination (#3656)

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -75976,6 +75976,7 @@ paths:
       x-pagination:
         limitParam: page[size]
         pageParam: page[number]
+        pageStart: 1
         resultsPath: data
     post:
       description: Create a Case

.generator/src/generator/templates/Api.j2

@@ -148,7 +148,7 @@ public class {{ name }} {
   String valueGetterPath = "";
   String valueSetterPath = "{%- if getters|length > 1 %}{{ ".".join(getters[:getters|length-1]) }}.{%- endif %}{{ setters[getters|length-1] }}";
   Boolean valueSetterParamOptional = {{ optional|lower }};
-  parameters.{% if getters|length > 1 %}{{ ".".join(getters[:getters|length-1]) }}.{%- endif %}{{ setters[getters|length-1] }}({{ 0|format_value(schema=paramSchema['schema']) }});
+  parameters.{% if getters|length > 1 %}{{ ".".join(getters[:getters|length-1]) }}.{%- endif %}{{ setters[getters|length-1] }}({{ (pagination.pageStart | default(0))|format_value(schema=paramSchema['schema']) }});
   {%- endif %}
 
 {#- Limit param field #}
@@ -205,7 +205,7 @@ public class {{ name }} {
   args.put("optionalParams", parameters);
   {%- endif  %}
 
-  PaginationIterable iterator = new PaginationIterable(this, "{{ operationId }}", resultsPath, valueGetterPath, valueSetterPath, valueSetterParamOptional, {% if pagination.pageParam %}false{% else %}true{% endif %}, limit, args);
+  PaginationIterable iterator = new PaginationIterable(this, "{{ operationId }}", resultsPath, valueGetterPath, valueSetterPath, valueSetterParamOptional, {% if pagination.pageParam %}false{% else %}true{% endif %}, limit, args, {{ pagination.pageStart | default(0) }});
 
   return iterator;
 {%- endmacro %}

.generator/src/generator/templates/PaginationIterable.j2

@@ -14,6 +14,7 @@ public class PaginationIterable<T> implements Iterable<T> {
   Boolean offsetPageIncrement;
   Object limit;
   LinkedHashMap<String, Object> args;
+  int pageStart;
 
   public PaginationIterable(
       Object requestClass,
@@ -24,7 +25,8 @@ public class PaginationIterable<T> implements Iterable<T> {
       Boolean valueSetterParamOptional,
       Boolean offsetPageIncrement,
       Object limit,
-      LinkedHashMap<String, Object> args) {
+      LinkedHashMap<String, Object> args,
+      int pageStart) {
 
     this.requestClass = requestClass;
     this.requestName = requestName;
@@ -41,6 +43,7 @@ public class PaginationIterable<T> implements Iterable<T> {
     this.offsetPageIncrement = offsetPageIncrement;
     this.limit = limit;
     this.args = args;
+    this.pageStart = pageStart;
   }
 
   @Override

.generator/src/generator/templates/PaginationIterator.j2

@@ -80,13 +80,13 @@ public class PaginationIterator<T> implements Iterator<T> {
         value = value.getClass().getMethod(path).invoke(value);
       }
     } else {
-      // fallback to pageOffset = totalCount;
+      // fallback to pageOffset = pageStart + totalCount;
       // We cast the type based on the setterMethod parameter type
       String pType = setterMethod.getParameterTypes()[0].getSimpleName();
       if ("Long".equals(pType)) {
-        value = (long) this.totalCount;
+        value = (long) (this.iterable.pageStart + this.totalCount);
       } else {
-        value = this.totalCount;
+        value = this.iterable.pageStart + this.totalCount;
       }
     }
 

examples/v2/case-management/SearchCases_3433960044.java

@@ -3,6 +3,7 @@
 import com.datadog.api.client.ApiClient;
 import com.datadog.api.client.PaginationIterable;
 import com.datadog.api.client.v2.api.CaseManagementApi;
+import com.datadog.api.client.v2.api.CaseManagementApi.SearchCasesOptionalParameters;
 import com.datadog.api.client.v2.model.Case;
 
 public class Example {
@@ -11,7 +12,9 @@ public static void main(String[] args) {
     CaseManagementApi apiInstance = new CaseManagementApi(defaultClient);
 
     try {
-      PaginationIterable<Case> iterable = apiInstance.searchCasesWithPagination();
+      PaginationIterable<Case> iterable =
+          apiInstance.searchCasesWithPagination(
+              new SearchCasesOptionalParameters().pageSize(2L).filter("status:closed"));
 
       for (Case item : iterable) {
         System.out.println(item);

src/main/java/com/datadog/api/client/PaginationIterable.java

@@ -18,6 +18,7 @@ public class PaginationIterable<T> implements Iterable<T> {
   Boolean offsetPageIncrement;
   Object limit;
   LinkedHashMap<String, Object> args;
+  int pageStart;
 
   public PaginationIterable(
       Object requestClass,
@@ -28,7 +29,8 @@ public PaginationIterable(
       Boolean valueSetterParamOptional,
       Boolean offsetPageIncrement,
       Object limit,
-      LinkedHashMap<String, Object> args) {
+      LinkedHashMap<String, Object> args,
+      int pageStart) {
 
     this.requestClass = requestClass;
     this.requestName = requestName;
@@ -45,6 +47,7 @@ public PaginationIterable(
     this.offsetPageIncrement = offsetPageIncrement;
     this.limit = limit;
     this.args = args;
+    this.pageStart = pageStart;
   }
 
   @Override

src/main/java/com/datadog/api/client/PaginationIterator.java

@@ -85,13 +85,13 @@ private void setNextPageValue(Object response)
         value = value.getClass().getMethod(path).invoke(value);
       }
     } else {
-      // fallback to pageOffset = totalCount;
+      // fallback to pageOffset = pageStart + totalCount;
       // We cast the type based on the setterMethod parameter type
       String pType = setterMethod.getParameterTypes()[0].getSimpleName();
       if ("Long".equals(pType)) {
-        value = (long) this.totalCount;
+        value = (long) (this.iterable.pageStart + this.totalCount);
       } else {
-        value = this.totalCount;
+        value = this.iterable.pageStart + this.totalCount;
       }
     }
 

src/main/java/com/datadog/api/client/v1/api/DashboardsApi.java

@@ -1544,7 +1544,8 @@ public PaginationIterable<DashboardSummaryDefinition> listDashboardsWithPaginati
             valueSetterParamOptional,
             true,
             limit,
-            args);
+            args,
+            0);
 
     return iterator;
   }

src/main/java/com/datadog/api/client/v1/api/MonitorsApi.java

@@ -1330,7 +1330,8 @@ public PaginationIterable<Monitor> listMonitorsWithPagination(
             valueSetterParamOptional,
             false,
             limit,
-            args);
+            args,
+            0);
 
     return iterator;
   }

src/main/java/com/datadog/api/client/v1/api/NotebooksApi.java

@@ -691,7 +691,8 @@ public PaginationIterable<NotebooksResponseData> listNotebooksWithPagination(
             valueSetterParamOptional,
             true,
             limit,
-            args);
+            args,
+            0);
 
     return iterator;
   }