Update List findings endpoint description (#2793)

Co-authored-by: ci.datadog-api-spec <[email protected]>
DataDog · Nov 19, 2024 · bd4b976 · bd4b976
1 parent b6067ce
commit bd4b976
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 7 deletions.
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-19 18:07:21.953644",
-            "spec_repo_commit": "f858f395"
+            "regenerated": "2024-11-19 19:45:49.445462",
+            "spec_repo_commit": "04f6c81e"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-11-19 18:07:21.972993",
-            "spec_repo_commit": "f858f395"
+            "regenerated": "2024-11-19 19:45:49.464481",
+            "spec_repo_commit": "04f6c81e"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -36249,9 +36249,10 @@ paths:
   /api/v2/posture_management/findings:
     get:
       description: "Get a list of findings. These include both misconfigurations and
-        identity risks.\n\n### Filtering\n\nFilters can be applied by appending query
-        parameters to the URL.\n\n  - Using a single filter: `?filter[attribute_key]=attribute_value`\n
-        \ - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n
+        identity risks.\n\n**Note**: To filter and return only identity risks, add
+        the following query parameter: `?filter[tags]=dd_rule_type:ciem`\n\n### Filtering\n\nFilters
+        can be applied by appending query parameters to the URL.\n\n  - Using a single
+        filter: `?filter[attribute_key]=attribute_value`\n  - Chaining filters: `?filter[attribute_key]=attribute_value&filter[attribute_key]=attribute_value...`\n
         \ - Filtering on tags: `?filter[tags]=tag_key:tag_value&filter[tags]=tag_key_2:tag_value_2`\n\nHere,
         `attribute_key` can be any of the filter keys described further below.\n\nQuery
         parameters of type `integer` support comparison operators (`>`, `>=`, `<`,

diff --git a/api/datadogV2/api_security_monitoring.go b/api/datadogV2/api_security_monitoring.go
@@ -1584,6 +1584,8 @@ func (r *ListFindingsOptionalParameters) WithFilterVulnerabilityType(filterVulne
 // ListFindings List findings.
 // Get a list of findings. These include both misconfigurations and identity risks.
 //
+// **Note**: To filter and return only identity risks, add the following query parameter: `?filter[tags]=dd_rule_type:ciem`
+//
 // ### Filtering
 //
 // Filters can be applied by appending query parameters to the URL.