fix case search documentation (#80)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>
Co-authored-by: Paul <[email protected]>
Co-authored-by: Hanting ZHANG <[email protected]>

Author: 4 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-11 15:35:27.700324",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:32:58.157121",
+            "spec_repo_commit": "5c7e123b"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-11 15:35:27.721018",
-            "spec_repo_commit": "8ffb168c"
+            "regenerated": "2024-04-15 13:32:58.174477",
+            "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/datadogV2/api/api_case_management.rs

@@ -18,8 +18,8 @@ use std::io::Write;
 pub struct SearchCasesOptionalParams {
     /// Size for a given page. The maximum allowed value is 100.
     pub page_size: Option<i64>,
-    /// Specific offset to use as the beginning of the returned page.
-    pub page_offset: Option<i64>,
+    /// Specific page number to return.
+    pub page_number: Option<i64>,
     /// Specify which field to sort
     pub sort_field: Option<crate::datadogV2::model::CaseSortableField>,
     /// Search query
@@ -34,9 +34,9 @@ impl SearchCasesOptionalParams {
         self.page_size = Some(value);
         self
     }
-    /// Specific offset to use as the beginning of the returned page.
-    pub fn page_offset(mut self, value: i64) -> Self {
-        self.page_offset = Some(value);
+    /// Specific page number to return.
+    pub fn page_number(mut self, value: i64) -> Self {
+        self.page_number = Some(value);
         self
     }
     /// Specify which field to sort
@@ -1234,6 +1234,9 @@ impl CaseManagementAPI {
             } else {
                 page_size = params.page_size.unwrap().clone();
             }
+            if params.page_number.is_none() {
+                params.page_number = Some(0);
+            }
             loop {
                 let resp = self.search_cases(params.clone()).await?;
                 let Some(data) = resp.data else { break };
@@ -1247,11 +1250,7 @@ impl CaseManagementAPI {
                 if count < page_size as usize {
                     break;
                 }
-                if params.page_offset.is_none() {
-                    params.page_offset = Some(page_size.clone());
-                } else {
-                    params.page_offset = Some(params.page_offset.unwrap() + page_size.clone());
-                }
+                params.page_number = Some(params.page_number.unwrap() + 1);
             }
         }
     }
@@ -1269,7 +1268,7 @@ impl CaseManagementAPI {
 
         // unbox and build optional parameters
         let page_size = params.page_size;
-        let page_offset = params.page_offset;
+        let page_number = params.page_number;
         let sort_field = params.sort_field;
         let filter = params.filter;
         let sort_asc = params.sort_asc;
@@ -1287,9 +1286,9 @@ impl CaseManagementAPI {
             local_req_builder =
                 local_req_builder.query(&[("page[size]", &local_query_param.to_string())]);
         };
-        if let Some(ref local_query_param) = page_offset {
+        if let Some(ref local_query_param) = page_number {
             local_req_builder =
-                local_req_builder.query(&[("page[offset]", &local_query_param.to_string())]);
+                local_req_builder.query(&[("page[number]", &local_query_param.to_string())]);
         };
         if let Some(ref local_query_param) = sort_field {
             local_req_builder =

tests/scenarios/function_mappings.rs

@@ -11139,8 +11139,8 @@ fn test_v2_search_cases(world: &mut DatadogWorld, _parameters: &HashMap<String,
     let page_size = _parameters
         .get("page[size]")
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
-    let page_offset = _parameters
-        .get("page[offset]")
+    let page_number = _parameters
+        .get("page[number]")
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
     let sort_field = _parameters
         .get("sort[field]")
@@ -11153,7 +11153,7 @@ fn test_v2_search_cases(world: &mut DatadogWorld, _parameters: &HashMap<String,
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
     let mut params = datadogV2::api_case_management::SearchCasesOptionalParams::default();
     params.page_size = page_size;
-    params.page_offset = page_offset;
+    params.page_number = page_number;
     params.sort_field = sort_field;
     params.filter = filter;
     params.sort_asc = sort_asc;
@@ -11186,8 +11186,8 @@ fn test_v2_search_cases_with_pagination(
     let page_size = _parameters
         .get("page[size]")
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
-    let page_offset = _parameters
-        .get("page[offset]")
+    let page_number = _parameters
+        .get("page[number]")
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
     let sort_field = _parameters
         .get("sort[field]")
@@ -11200,7 +11200,7 @@ fn test_v2_search_cases_with_pagination(
         .and_then(|param| Some(serde_json::from_value(param.clone()).unwrap()));
     let mut params = datadogV2::api_case_management::SearchCasesOptionalParams::default();
     params.page_size = page_size;
-    params.page_offset = page_offset;
+    params.page_number = page_number;
     params.sort_field = sort_field;
     params.filter = filter;
     params.sort_asc = sort_asc;