Skip to content

Commit 9e90a75

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Observability Pipelines - Updating descriptions and making the tags field optional not required (#3221)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 7ce8521 commit 9e90a75

6 files changed

Lines changed: 17 additions & 12 deletions

.generator/schemas/v2/openapi.yaml

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -44218,7 +44218,10 @@ components:
4421844218
action:
4421944219
$ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction"
4422044220
options:
44221-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`.
44221+
description: |-
44222+
Optional settings for the hash action. When omitted or empty, matched sensitive data is
44223+
replaced with a deterministic hashed value that preserves structure for analytics while
44224+
protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
4422244225
type: object
4422344226
required: [action]
4422444227
type: object
@@ -44249,7 +44252,7 @@ components:
4424944252
description: Controls how partial redaction is applied, including character count and direction.
4425044253
properties:
4425144254
characters:
44252-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`.
44255+
description: Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
4425344256
example: 4
4425444257
format: int64
4425544258
type: integer
@@ -44285,7 +44288,7 @@ components:
4428544288
description: Configuration for fully redacting sensitive data.
4428644289
properties:
4428744290
replace:
44288-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`.
44291+
description: The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
4428944292
example: "***"
4429044293
type: string
4429144294
required: [replace]
@@ -44395,7 +44398,6 @@ components:
4439544398
type: array
4439644399
required:
4439744400
- name
44398-
- tags
4439944401
- pattern
4440044402
- scope
4440144403
- on_match
@@ -44456,7 +44458,7 @@ components:
4445644458
description: Fields to which the scope rule applies.
4445744459
properties:
4445844460
fields:
44459-
description: The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`.
44461+
description: List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
4446044462
example:
4446144463
- ""
4446244464
items:

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_action_hash.py

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,7 +48,9 @@ def __init__(
4848
:param action: Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content.
4949
:type action: ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction
5050
51-
:param options: The ``ObservabilityPipelineSensitiveDataScannerProcessorActionHash`` ``options``.
51+
:param options: Optional settings for the hash action. When omitted or empty, matched sensitive data is
52+
replaced with a deterministic hashed value that preserves structure for analytics while
53+
protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
5254
:type options: dict, optional
5355
"""
5456
if options is not unset:

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_action_partial_redact_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ def __init__(
4343
"""
4444
Controls how partial redaction is applied, including character count and direction.
4545
46-
:param characters: The ``ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions`` ``characters``.
46+
:param characters: Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
4747
:type characters: int
4848
4949
:param direction: Indicates whether to redact characters from the first or last part of the matched value.

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_action_redact_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ def __init__(self_, replace: str, **kwargs):
2525
"""
2626
Configuration for fully redacting sensitive data.
2727
28-
:param replace: The ``ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions`` ``replace``.
28+
:param replace: The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
2929
:type replace: str
3030
"""
3131
super().__init__(kwargs)

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_rule.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -106,8 +106,8 @@ def __init__(
106106
ObservabilityPipelineSensitiveDataScannerProcessorScopeExclude,
107107
ObservabilityPipelineSensitiveDataScannerProcessorScopeAll,
108108
],
109-
tags: List[str],
110109
keyword_options: Union[ObservabilityPipelineSensitiveDataScannerProcessorKeywordOptions, UnsetType] = unset,
110+
tags: Union[List[str], UnsetType] = unset,
111111
**kwargs,
112112
):
113113
"""
@@ -129,14 +129,15 @@ def __init__(
129129
:type scope: ObservabilityPipelineSensitiveDataScannerProcessorScope
130130
131131
:param tags: Tags assigned to this rule for filtering and classification.
132-
:type tags: [str]
132+
:type tags: [str], optional
133133
"""
134134
if keyword_options is not unset:
135135
kwargs["keyword_options"] = keyword_options
136+
if tags is not unset:
137+
kwargs["tags"] = tags
136138
super().__init__(kwargs)
137139

138140
self_.name = name
139141
self_.on_match = on_match
140142
self_.pattern = pattern
141143
self_.scope = scope
142-
self_.tags = tags

src/datadog_api_client/v2/model/observability_pipeline_sensitive_data_scanner_processor_scope_options.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ def __init__(self_, fields: List[str], **kwargs):
2626
"""
2727
Fields to which the scope rule applies.
2828
29-
:param fields: The ``ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions`` ``fields``.
29+
:param fields: List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
3030
:type fields: [str]
3131
"""
3232
super().__init__(kwargs)

0 commit comments

Comments
 (0)