Support an optional description field on SDS rule patterns

.generator/schemas/v2/openapi.yaml

@@ -37907,6 +37907,11 @@ components:
     ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions:
       description: Options for defining a custom regex pattern.
       properties:
+        description:
+          description: Human-readable description providing context about a sensitive
+            data scanner rule
+          example: "Custom regex for internal API\u202Fkeys"
+          type: string
         rule:
           description: A regular expression used to detect sensitive values. Must
             be a valid regex.
@@ -37962,6 +37967,11 @@ components:
       description: Options for selecting a predefined library pattern and enabling
         keyword support.
       properties:
+        description:
+          description: Human-readable description providing context about a sensitive
+            data scanner rule
+          example: Credit card pattern
+          type: string
         id:
           description: Identifier for a predefined pattern from the sensitive data
             scanner pattern library.

src/datadogV2/model/model_observability_pipeline_sensitive_data_scanner_processor_custom_pattern_options.rs

@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
+    /// Human-readable description providing context about a sensitive data scanner rule
+    #[serde(rename = "description")]
+    pub description: Option<String>,
     /// A regular expression used to detect sensitive values. Must be a valid regex.
     #[serde(rename = "rule")]
     pub rule: String,
@@ -26,12 +29,18 @@ impl ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
         rule: String,
     ) -> ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
         ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
+            description: None,
             rule,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn description(mut self, value: String) -> Self {
+        self.description = Some(value);
+        self
+    }
+
     pub fn additional_properties(
         mut self,
         value: std::collections::BTreeMap<String, serde_json::Value>,
@@ -62,6 +71,7 @@ impl<'de> Deserialize<'de>
             where
                 M: MapAccess<'a>,
             {
+                let mut description: Option<String> = None;
                 let mut rule: Option<String> = None;
                 let mut additional_properties: std::collections::BTreeMap<
                     String,
@@ -71,6 +81,13 @@ impl<'de> Deserialize<'de>
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
+                        "description" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            description =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "rule" => {
                             rule = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
@@ -85,6 +102,7 @@ impl<'de> Deserialize<'de>
 
                 let content =
                     ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions {
+                        description,
                         rule,
                         additional_properties,
                         _unparsed,

src/datadogV2/model/model_observability_pipeline_sensitive_data_scanner_processor_library_pattern_options.rs

@@ -11,6 +11,9 @@ use std::fmt::{self, Formatter};
 #[skip_serializing_none]
 #[derive(Clone, Debug, PartialEq, Serialize)]
 pub struct ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
+    /// Human-readable description providing context about a sensitive data scanner rule
+    #[serde(rename = "description")]
+    pub description: Option<String>,
     /// Identifier for a predefined pattern from the sensitive data scanner pattern library.
     #[serde(rename = "id")]
     pub id: String,
@@ -29,13 +32,19 @@ impl ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
         id: String,
     ) -> ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
         ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
+            description: None,
             id,
             use_recommended_keywords: None,
             additional_properties: std::collections::BTreeMap::new(),
             _unparsed: false,
         }
     }
 
+    pub fn description(mut self, value: String) -> Self {
+        self.description = Some(value);
+        self
+    }
+
     pub fn use_recommended_keywords(mut self, value: bool) -> Self {
         self.use_recommended_keywords = Some(value);
         self
@@ -71,6 +80,7 @@ impl<'de> Deserialize<'de>
             where
                 M: MapAccess<'a>,
             {
+                let mut description: Option<String> = None;
                 let mut id: Option<String> = None;
                 let mut use_recommended_keywords: Option<bool> = None;
                 let mut additional_properties: std::collections::BTreeMap<
@@ -81,6 +91,13 @@ impl<'de> Deserialize<'de>
 
                 while let Some((k, v)) = map.next_entry::<String, serde_json::Value>()? {
                     match k.as_str() {
+                        "description" => {
+                            if v.is_null() {
+                                continue;
+                            }
+                            description =
+                                Some(serde_json::from_value(v).map_err(M::Error::custom)?);
+                        }
                         "id" => {
                             id = Some(serde_json::from_value(v).map_err(M::Error::custom)?);
                         }
@@ -102,6 +119,7 @@ impl<'de> Deserialize<'de>
 
                 let content =
                     ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions {
+                        description,
                         id,
                         use_recommended_keywords,
                         additional_properties,

tests/scenarios/cassettes/v2/observability_pipelines/Create-a-new-pipeline-returns-Bad-Request-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:15.575Z
+2025-12-23T13:57:28.936Z

tests/scenarios/cassettes/v2/observability_pipelines/Create-a-new-pipeline-returns-Bad-Request-response.json

@@ -15,7 +15,7 @@
           ]
         },
         "method": "post",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines"
       },
       "response": {
         "body": {
@@ -32,7 +32,7 @@
           "message": "Bad Request"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:15 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:28 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/Create-a-new-pipeline-returns-OK-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:16.062Z
+2025-12-23T13:57:29.402Z

tests/scenarios/cassettes/v2/observability_pipelines/Create-a-new-pipeline-returns-OK-response.json

@@ -15,11 +15,11 @@
           ]
         },
         "method": "post",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines"
       },
       "response": {
         "body": {
-          "string": "{\"data\":{\"id\":\"bd8d693c-dc2c-11f0-bf69-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+          "string": "{\"data\":{\"id\":\"524b89d6-e007-11f0-8e9d-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"my-processor-group\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"enabled\":true,\"id\":\"my-processor-group\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
           "encoding": null
         },
         "headers": {
@@ -32,7 +32,7 @@
           "message": "Created"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:16 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:29 GMT"
     },
     {
       "request": {
@@ -43,7 +43,7 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/bd8d693c-dc2c-11f0-bf69-da7ad0900002"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/524b89d6-e007-11f0-8e9d-da7ad0900002"
       },
       "response": {
         "body": {
@@ -60,7 +60,7 @@
           "message": "No Content"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:16 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:29 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/Delete-a-pipeline-returns-Not-Found-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:17.165Z
+2025-12-23T13:57:30.502Z

tests/scenarios/cassettes/v2/observability_pipelines/Delete-a-pipeline-returns-Not-Found-response.json

@@ -9,7 +9,7 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/3fa85f64-5717-4562-b3fc-2c963f66afa6"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/3fa85f64-5717-4562-b3fc-2c963f66afa6"
       },
       "response": {
         "body": {
@@ -26,7 +26,7 @@
           "message": "Not Found"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:17 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:30 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/Delete-a-pipeline-returns-OK-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:17.716Z
+2025-12-23T13:57:31.004Z

tests/scenarios/cassettes/v2/observability_pipelines/Delete-a-pipeline-returns-OK-response.json

@@ -15,11 +15,11 @@
           ]
         },
         "method": "post",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines"
       },
       "response": {
         "body": {
-          "string": "{\"data\":{\"id\":\"be89fea4-dc2c-11f0-bdea-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+          "string": "{\"data\":{\"id\":\"533d1e9a-e007-11f0-a813-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
           "encoding": null
         },
         "headers": {
@@ -32,7 +32,7 @@
           "message": "Created"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:17 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:31 GMT"
     },
     {
       "request": {
@@ -43,7 +43,7 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/533d1e9a-e007-11f0-a813-da7ad0900002"
       },
       "response": {
         "body": {
@@ -60,7 +60,7 @@
           "message": "No Content"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:17 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:31 GMT"
     },
     {
       "request": {
@@ -71,7 +71,7 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/be89fea4-dc2c-11f0-bdea-da7ad0900002"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/533d1e9a-e007-11f0-a813-da7ad0900002"
       },
       "response": {
         "body": {
@@ -88,7 +88,7 @@
           "message": "Not Found"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:17 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:31 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/Get-a-specific-pipeline-returns-OK-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:20.018Z
+2025-12-23T13:57:33.162Z

tests/scenarios/cassettes/v2/observability_pipelines/Get-a-specific-pipeline-returns-OK-response.json

@@ -15,11 +15,11 @@
           ]
         },
         "method": "post",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines"
       },
       "response": {
         "body": {
-          "string": "{\"data\":{\"id\":\"bfe664a4-dc2c-11f0-bdec-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+          "string": "{\"data\":{\"id\":\"548721ec-e007-11f0-9055-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
           "encoding": null
         },
         "headers": {
@@ -32,7 +32,7 @@
           "message": "Created"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:20 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:33 GMT"
     },
     {
       "request": {
@@ -43,11 +43,11 @@
           ]
         },
         "method": "get",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/bfe664a4-dc2c-11f0-bdec-da7ad0900002"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/548721ec-e007-11f0-9055-da7ad0900002"
       },
       "response": {
         "body": {
-          "string": "{\"data\":{\"id\":\"bfe664a4-dc2c-11f0-bdec-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
+          "string": "{\"data\":{\"id\":\"548721ec-e007-11f0-9055-da7ad0900002\",\"type\":\"pipelines\",\"attributes\":{\"name\":\"Main Observability Pipeline\",\"config\":{\"destinations\":[{\"id\":\"datadog-logs-destination\",\"inputs\":[\"processor-group-0\"],\"type\":\"datadog_logs\"}],\"processors\":[{\"display_name\":\"My Processor Group\",\"enabled\":true,\"id\":\"processor-group-0\",\"include\":\"service:my-service\",\"inputs\":[\"datadog-agent-source\"],\"processors\":[{\"display_name\":\"My Filter Processor\",\"enabled\":true,\"id\":\"filter-processor\",\"include\":\"status:error\",\"type\":\"filter\"}]}],\"sources\":[{\"id\":\"datadog-agent-source\",\"type\":\"datadog_agent\"}]}}}}\n",
           "encoding": null
         },
         "headers": {
@@ -60,7 +60,7 @@
           "message": "OK"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:20 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:33 GMT"
     },
     {
       "request": {
@@ -71,7 +71,7 @@
           ]
         },
         "method": "delete",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/bfe664a4-dc2c-11f0-bdec-da7ad0900002"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/548721ec-e007-11f0-9055-da7ad0900002"
       },
       "response": {
         "body": {
@@ -88,7 +88,7 @@
           "message": "No Content"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:20 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:33 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/List-pipelines-returns-Bad-Request-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:22.038Z
+2025-12-23T13:57:35.329Z

tests/scenarios/cassettes/v2/observability_pipelines/List-pipelines-returns-Bad-Request-response.json

@@ -9,7 +9,7 @@
           ]
         },
         "method": "get",
-        "uri": "https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines?page%5Bsize%5D=0"
+        "uri": "https://api.datadoghq.com/api/v2/obs-pipelines/pipelines?page%5Bsize%5D=0"
       },
       "response": {
         "body": {
@@ -26,7 +26,7 @@
           "message": "Bad Request"
         }
       },
-      "recorded_at": "Thu, 18 Dec 2025 16:15:22 GMT"
+      "recorded_at": "Tue, 23 Dec 2025 13:57:35 GMT"
     }
   ],
   "recorded_with": "VCR 6.0.0"

tests/scenarios/cassettes/v2/observability_pipelines/List-pipelines-returns-OK-response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:22.507Z
+2025-12-23T13:57:35.773Z