fix case search documentation (#1598)

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.6",
-            "regenerated": "2024-04-11 15:35:24.319441",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:33:00.832246",
+            "spec_repo_commit": "5c7e123b"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-11 15:35:24.337042",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:33:00.850485",
+            "spec_repo_commit": "5c7e123b"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -23926,7 +23926,7 @@ paths:
       operationId: SearchCases
       parameters:
       - $ref: '#/components/parameters/PageSize'
-      - $ref: '#/components/parameters/PageOffset'
+      - $ref: '#/components/parameters/PageNumber'
       - $ref: '#/components/parameters/CaseSortableFieldParameter'
       - description: Search query
         in: query
@@ -23969,7 +23969,7 @@ paths:
       - Case Management
       x-pagination:
         limitParam: page[size]
-        pageOffsetParam: page[offset]
+        pageParam: page[number]
         resultsPath: data
     post:
       description: Create a Case

features/support/scenarios_model_mapping.ts

@@ -2671,7 +2671,7 @@ export const ScenariosModelMappings: {[key: string]: {[key: string]: any}} = {
             "type": "number",
             "format": "int64",
             },
-        "pageOffset": {
+        "pageNumber": {
             "type": "number",
             "format": "int64",
             },

packages/datadog-api-client-v2/apis/CaseManagementApi.ts

@@ -344,7 +344,7 @@ export class CaseManagementApiRequestFactory extends BaseAPIRequestFactory {
 
   public async searchCases(
     pageSize?: number,
-    pageOffset?: number,
+    pageNumber?: number,
     sortField?: CaseSortableField,
     filter?: string,
     sortAsc?: boolean,
@@ -369,10 +369,10 @@ export class CaseManagementApiRequestFactory extends BaseAPIRequestFactory {
         ObjectSerializer.serialize(pageSize, "number", "int64")
       );
     }
-    if (pageOffset !== undefined) {
+    if (pageNumber !== undefined) {
       requestContext.setQueryParam(
-        "page[offset]",
-        ObjectSerializer.serialize(pageOffset, "number", "int64")
+        "page[number]",
+        ObjectSerializer.serialize(pageNumber, "number", "int64")
       );
     }
     if (sortField !== undefined) {
@@ -1490,10 +1490,10 @@ export interface CaseManagementApiSearchCasesRequest {
    */
   pageSize?: number;
   /**
-   * Specific offset to use as the beginning of the returned page.
+   * Specific page number to return.
    * @type number
    */
-  pageOffset?: number;
+  pageNumber?: number;
   /**
    * Specify which field to sort
    * @type CaseSortableField
@@ -1754,7 +1754,7 @@ export class CaseManagementApi {
   ): Promise<CasesResponse> {
     const requestContextPromise = this.requestFactory.searchCases(
       param.pageSize,
-      param.pageOffset,
+      param.pageNumber,
       param.sortField,
       param.filter,
       param.sortAsc,
@@ -1781,10 +1781,11 @@ export class CaseManagementApi {
       pageSize = param.pageSize;
     }
     param.pageSize = pageSize;
+    param.pageNumber = 0;
     while (true) {
       const requestContext = await this.requestFactory.searchCases(
         param.pageSize,
-        param.pageOffset,
+        param.pageNumber,
         param.sortField,
         param.filter,
         param.sortAsc,
@@ -1808,11 +1809,7 @@ export class CaseManagementApi {
       if (results.length < pageSize) {
         break;
       }
-      if (param.pageOffset === undefined) {
-        param.pageOffset = pageSize;
-      } else {
-        param.pageOffset = param.pageOffset + pageSize;
-      }
+      param.pageNumber = param.pageNumber + 1;
     }
   }