fix case search documentation (#1943)

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:31.200778",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:32:56.776195",
+            "spec_repo_commit": "5c7e123b"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-11 15:35:31.217642",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:32:56.793599",
+            "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

src/datadog_api_client/v2/api/case_management_api.py

@@ -230,9 +230,9 @@ def __init__(self, api_client=None):
                     "attribute": "page[size]",
                     "location": "query",
                 },
-                "page_offset": {
+                "page_number": {
                     "openapi_types": (int,),
-                    "attribute": "page[offset]",
+                    "attribute": "page[number]",
                     "location": "query",
                 },
                 "sort_field": {
@@ -506,7 +506,7 @@ def search_cases(
         self,
         *,
         page_size: Union[int, UnsetType] = unset,
-        page_offset: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
         sort_field: Union[CaseSortableField, UnsetType] = unset,
         filter: Union[str, UnsetType] = unset,
         sort_asc: Union[bool, UnsetType] = unset,
@@ -517,8 +517,8 @@ def search_cases(
 
         :param page_size: Size for a given page. The maximum allowed value is 100.
         :type page_size: int, optional
-        :param page_offset: Specific offset to use as the beginning of the returned page.
-        :type page_offset: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
         :param sort_field: Specify which field to sort
         :type sort_field: CaseSortableField, optional
         :param filter: Search query
@@ -531,8 +531,8 @@ def search_cases(
         if page_size is not unset:
             kwargs["page_size"] = page_size
 
-        if page_offset is not unset:
-            kwargs["page_offset"] = page_offset
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
 
         if sort_field is not unset:
             kwargs["sort_field"] = sort_field
@@ -549,7 +549,7 @@ def search_cases_with_pagination(
         self,
         *,
         page_size: Union[int, UnsetType] = unset,
-        page_offset: Union[int, UnsetType] = unset,
+        page_number: Union[int, UnsetType] = unset,
         sort_field: Union[CaseSortableField, UnsetType] = unset,
         filter: Union[str, UnsetType] = unset,
         sort_asc: Union[bool, UnsetType] = unset,
@@ -560,8 +560,8 @@ def search_cases_with_pagination(
 
         :param page_size: Size for a given page. The maximum allowed value is 100.
         :type page_size: int, optional
-        :param page_offset: Specific offset to use as the beginning of the returned page.
-        :type page_offset: int, optional
+        :param page_number: Specific page number to return.
+        :type page_number: int, optional
         :param sort_field: Specify which field to sort
         :type sort_field: CaseSortableField, optional
         :param filter: Search query
@@ -576,8 +576,8 @@ def search_cases_with_pagination(
         if page_size is not unset:
             kwargs["page_size"] = page_size
 
-        if page_offset is not unset:
-            kwargs["page_offset"] = page_offset
+        if page_number is not unset:
+            kwargs["page_number"] = page_number
 
         if sort_field is not unset:
             kwargs["sort_field"] = sort_field
@@ -594,7 +594,7 @@ def search_cases_with_pagination(
         pagination = {
             "limit_value": local_page_size,
             "results_path": "data",
-            "page_offset_param": "page_offset",
+            "page_param": "page_number",
             "endpoint": endpoint,
             "kwargs": kwargs,
         }