Skip to content

Commit 94c3975

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

6 files changed

+14
-11
lines changed

.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:

services/observability_pipelines/src/v2/models/ObservabilityPipelineSensitiveDataScannerProcessorActionHash.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,9 @@ export class ObservabilityPipelineSensitiveDataScannerProcessorActionHash {
1111
*/
1212
"action": ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction;
1313
/**
14-
* The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`.
14+
* Optional settings for the hash action. When omitted or empty, matched sensitive data is
15+
* replaced with a deterministic hashed value that preserves structure for analytics while
16+
* protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
1517
*/
1618
"options"?: any;
1719
/**

services/observability_pipelines/src/v2/models/ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ import { ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOp
77
*/
88
export class ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions {
99
/**
10-
* The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`.
10+
* Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
1111
*/
1212
"characters": number;
1313
/**

services/observability_pipelines/src/v2/models/ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
55
*/
66
export class ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions {
77
/**
8-
* The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`.
8+
* The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
99
*/
1010
"replace": string;
1111
/**

services/observability_pipelines/src/v2/models/ObservabilityPipelineSensitiveDataScannerProcessorRule.ts

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ export class ObservabilityPipelineSensitiveDataScannerProcessorRule {
3232
/**
3333
* Tags assigned to this rule for filtering and classification.
3434
*/
35-
"tags": Array<string>;
35+
"tags"?: Array<string>;
3636
/**
3737
* A container for additional, undeclared properties.
3838
* This is a holder for any undeclared properties as specified with
@@ -75,7 +75,6 @@ export class ObservabilityPipelineSensitiveDataScannerProcessorRule {
7575
tags: {
7676
baseName: "tags",
7777
type: "Array<string>",
78-
required: true,
7978
},
8079
additionalProperties: {
8180
baseName: "additionalProperties",

services/observability_pipelines/src/v2/models/ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { AttributeTypeMap } from "@datadog/datadog-api-client";
55
*/
66
export class ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions {
77
/**
8-
* The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`.
8+
* List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
99
*/
1010
"fields": Array<string>;
1111
/**

0 commit comments

Comments
 (0)