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/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_custom_pattern_options.py

@@ -3,31 +3,41 @@
 # Copyright 2019-Present Datadog, Inc.
 from __future__ import annotations
 
+from typing import Union
 
 from datadog_api_client.model_utils import (
     ModelNormal,
     cached_property,
+    unset,
+    UnsetType,
 )
 
 
 class ObservabilityPipelineSensitiveDataScannerProcessorCustomPatternOptions(ModelNormal):
     @cached_property
     def openapi_types(_):
         return {
+            "description": (str,),
             "rule": (str,),
         }
 
     attribute_map = {
+        "description": "description",
         "rule": "rule",
     }
 
-    def __init__(self_, rule: str, **kwargs):
+    def __init__(self_, rule: str, description: Union[str, UnsetType] = unset, **kwargs):
         """
         Options for defining a custom regex pattern.
 
+        :param description: Human-readable description providing context about a sensitive data scanner rule
+        :type description: str, optional
+
         :param rule: A regular expression used to detect sensitive values. Must be a valid regex.
         :type rule: str
         """
+        if description is not unset:
+            kwargs["description"] = description
         super().__init__(kwargs)
 
         self_.rule = rule

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_library_pattern_options.py

@@ -17,25 +17,38 @@ class ObservabilityPipelineSensitiveDataScannerProcessorLibraryPatternOptions(Mo
     @cached_property
     def openapi_types(_):
         return {
+            "description": (str,),
             "id": (str,),
             "use_recommended_keywords": (bool,),
         }
 
     attribute_map = {
+        "description": "description",
         "id": "id",
         "use_recommended_keywords": "use_recommended_keywords",
     }
 
-    def __init__(self_, id: str, use_recommended_keywords: Union[bool, UnsetType] = unset, **kwargs):
+    def __init__(
+        self_,
+        id: str,
+        description: Union[str, UnsetType] = unset,
+        use_recommended_keywords: Union[bool, UnsetType] = unset,
+        **kwargs,
+    ):
         """
         Options for selecting a predefined library pattern and enabling keyword support.
 
+        :param description: Human-readable description providing context about a sensitive data scanner rule
+        :type description: str, optional
+
         :param id: Identifier for a predefined pattern from the sensitive data scanner pattern library.
         :type id: str
 
         :param use_recommended_keywords: Whether to augment the pattern with recommended keywords (optional).
         :type use_recommended_keywords: bool, optional
         """
+        if description is not unset:
+            kwargs["description"] = description
         if use_recommended_keywords is not unset:
             kwargs["use_recommended_keywords"] = use_recommended_keywords
         super().__init__(kwargs)

tests/v2/cassettes/test_scenarios/test_create_a_new_pipeline_returns_bad_request_response.frozen

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

tests/v2/cassettes/test_scenarios/test_create_a_new_pipeline_returns_bad_request_response.yaml

@@ -8,7 +8,7 @@ interactions:
       content-type:
       - application/json
     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: '{"errors":[{"title":"Component with ID my-processor-group is an unknown

tests/v2/cassettes/test_scenarios/test_create_a_new_pipeline_returns_ok_response.frozen

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

tests/v2/cassettes/test_scenarios/test_create_a_new_pipeline_returns_ok_response.yaml

@@ -8,10 +8,10 @@ interactions:
       content-type:
       - application/json
     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
+      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"}]}}}}
 
         '
@@ -27,7 +27,7 @@ interactions:
       accept:
       - '*/*'
     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:
       string: ''

tests/v2/cassettes/test_scenarios/test_delete_a_pipeline_returns_not_found_response.frozen

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

tests/v2/cassettes/test_scenarios/test_delete_a_pipeline_returns_not_found_response.yaml

@@ -5,7 +5,7 @@ interactions:
       accept:
       - '*/*'
     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:
       string: '{"errors":[{"title":"Resource Not Found"}]}

tests/v2/cassettes/test_scenarios/test_delete_a_pipeline_returns_ok_response.frozen

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

tests/v2/cassettes/test_scenarios/test_delete_a_pipeline_returns_ok_response.yaml

@@ -10,10 +10,10 @@ interactions:
       content-type:
       - application/json
     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
+      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"}]}}}}
@@ -31,7 +31,7 @@ interactions:
       accept:
       - '*/*'
     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:
       string: ''
@@ -47,7 +47,7 @@ interactions:
       accept:
       - '*/*'
     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:
       string: '{"errors":[{"title":"Resource Not Found"}]}

tests/v2/cassettes/test_scenarios/test_get_a_specific_pipeline_returns_ok_response.frozen

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

tests/v2/cassettes/test_scenarios/test_get_a_specific_pipeline_returns_ok_response.yaml

@@ -10,10 +10,10 @@ interactions:
       content-type:
       - application/json
     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
+      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"}]}}}}
@@ -31,10 +31,10 @@ interactions:
       accept:
       - application/json
     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
+      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"}]}}}}
@@ -52,7 +52,7 @@ interactions:
       accept:
       - '*/*'
     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:
       string: ''

tests/v2/cassettes/test_scenarios/test_list_pipelines_returns_bad_request_response.frozen

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

tests/v2/cassettes/test_scenarios/test_list_pipelines_returns_bad_request_response.yaml

@@ -5,7 +5,7 @@ interactions:
       accept:
       - application/json
     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:
       string: '{"errors":[{"title":"page[size] must be a number between 1 and 50"}]}

tests/v2/cassettes/test_scenarios/test_list_pipelines_returns_ok_response.frozen

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

tests/v2/cassettes/test_scenarios/test_list_pipelines_returns_ok_response.yaml

@@ -10,10 +10,10 @@ interactions:
       content-type:
       - application/json
     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":"c162e83e-dc2c-11f0-bf6b-da7ad0900002","type":"pipelines","attributes":{"name":"Main
+      string: '{"data":{"id":"56108288-e007-11f0-a815-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"}]}}}}
@@ -31,13 +31,15 @@ interactions:
       accept:
       - application/json
     method: GET
-    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":"c162e83e-dc2c-11f0-bf6b-da7ad0900002","type":"pipelines","attributes":{"name":"Main
+      string: '{"data":[{"id":"4bf478ba-dc68-11f0-87e9-da7ad0900002","type":"pipelines","attributes":{"name":"Main
+        Observability Pipeline","config":{"destinations":[{"id":"datadog-logs-destination","inputs":["processor-group-0"],"type":"datadog_logs"}],"processors":[{"enabled":true,"id":"processor-group-0","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"}]}}},{"id":"a78e416a-de66-11f0-a039-da7ad0900002","type":"pipelines","attributes":{"name":"http-server-pipeline","config":{"destinations":[{"id":"destination-1","inputs":["http-source-1"],"type":"datadog_logs"}],"processors":[],"sources":[{"auth_strategy":"plain","decoding":"json","id":"http-source-1","tls":{"ca_file":"/etc/ssl/certs/ca.crt","crt_file":"/etc/ssl/certs/http.crt","key_file":"/etc/ssl/private/http.key"},"type":"http_server"}]}}},{"id":"a84fd58c-de66-11f0-a03b-da7ad0900002","type":"pipelines","attributes":{"name":"amazon_s3-source-pipeline","config":{"destinations":[{"id":"destination-1","inputs":["s3-source-1"],"type":"datadog_logs"}],"processors":[],"sources":[{"auth":{"assume_role":"arn:aws:iam::123456789012:role/test-role","external_id":"external-test-id","session_name":"session-test"},"id":"s3-source-1","region":"us-east-1","tls":{"ca_file":"/etc/ssl/certs/s3.ca","crt_file":"/etc/ssl/certs/s3.crt","key_file":"/etc/ssl/private/s3.key"},"type":"amazon_s3"}]}}},{"id":"a42e22e0-df49-11f0-81d5-da7ad0900002","type":"pipelines","attributes":{"name":"dedupe
+        pipeline","config":{"destinations":[{"id":"destination-1","inputs":["dedupe-group-2"],"type":"datadog_logs"}],"processors":[{"enabled":true,"id":"dedupe-group-1","include":"*","inputs":["source-1"],"processors":[{"enabled":true,"fields":["log.message","log.tags"],"id":"dedupe-match","include":"*","mode":"match","type":"dedupe"}]},{"enabled":true,"id":"dedupe-group-2","include":"*","inputs":["dedupe-group-1"],"processors":[{"enabled":true,"fields":["log.source","log.context"],"id":"dedupe-ignore","include":"*","mode":"ignore","type":"dedupe"}]}],"sources":[{"id":"source-1","type":"datadog_agent"}]}}},{"id":"56108288-e007-11f0-a815-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"}]}}}],"meta":{"totalCount":1}}
+        Filter Processor","enabled":true,"id":"filter-processor","include":"status:error","type":"filter"}]}],"sources":[{"id":"datadog-agent-source","type":"datadog_agent"}]}}}],"meta":{"totalCount":5}}
 
         '
     headers:
@@ -52,7 +54,7 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/c162e83e-dc2c-11f0-bf6b-da7ad0900002
+    uri: https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/56108288-e007-11f0-a815-da7ad0900002
   response:
     body:
       string: ''

tests/v2/cassettes/test_scenarios/test_update_a_pipeline_returns_bad_request_response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:24.455Z
+2025-12-23T13:57:37.865Z

tests/v2/cassettes/test_scenarios/test_update_a_pipeline_returns_bad_request_response.yaml

@@ -10,10 +10,10 @@ interactions:
       content-type:
       - application/json
     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":"c28a5ad0-dc2c-11f0-bdee-da7ad0900002","type":"pipelines","attributes":{"name":"Main
+      string: '{"data":{"id":"575002c2-e007-11f0-9057-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"}]}}}}
@@ -34,7 +34,7 @@ interactions:
       content-type:
       - application/json
     method: PUT
-    uri: https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/c28a5ad0-dc2c-11f0-bdee-da7ad0900002
+    uri: https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/575002c2-e007-11f0-9057-da7ad0900002
   response:
     body:
       string: '{"errors":[{"title":"Component with ID my-processor-group is an unknown
@@ -56,7 +56,7 @@ interactions:
       accept:
       - '*/*'
     method: DELETE
-    uri: https://api.datadoghq.com/api/v2/remote_config/products/obs_pipelines/pipelines/c28a5ad0-dc2c-11f0-bdee-da7ad0900002
+    uri: https://api.datadoghq.com/api/v2/obs-pipelines/pipelines/575002c2-e007-11f0-9057-da7ad0900002
   response:
     body:
       string: ''

tests/v2/cassettes/test_scenarios/test_update_a_pipeline_returns_not_found_response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:26.411Z
+2025-12-23T13:57:39.819Z

tests/v2/cassettes/test_scenarios/test_update_a_pipeline_returns_not_found_response.yaml

@@ -8,7 +8,7 @@ interactions:
       content-type:
       - application/json
     method: PUT
-    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:
       string: '{"errors":[{"title":"Not Found"}]}

tests/v2/cassettes/test_scenarios/test_update_a_pipeline_returns_ok_response.frozen

@@ -1 +1 @@
-2025-12-18T16:15:26.929Z
+2025-12-23T13:57:40.293Z