Observability Pipelines - Updating descriptions and making the tags field optional not required (#3739)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

Author: api-clients-generation-pipeline[bot]

.generator/schemas/v2/openapi.yaml

@@ -44218,7 +44218,10 @@ components:
         action:
           $ref: "#/components/schemas/ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction"
         options:
-          description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`.
+          description: |-
+            Optional settings for the hash action. When omitted or empty, matched sensitive data is
+            replaced with a deterministic hashed value that preserves structure for analytics while
+            protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
           type: object
       required: [action]
       type: object
@@ -44249,7 +44252,7 @@ components:
       description: Controls how partial redaction is applied, including character count and direction.
       properties:
         characters:
-          description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`.
+          description: Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
           example: 4
           format: int64
           type: integer
@@ -44285,7 +44288,7 @@ components:
       description: Configuration for fully redacting sensitive data.
       properties:
         replace:
-          description: The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`.
+          description: The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
           example: "***"
           type: string
       required: [replace]
@@ -44395,7 +44398,6 @@ components:
           type: array
       required:
         - name
-        - tags
         - pattern
         - scope
         - on_match
@@ -44456,7 +44458,7 @@ components:
       description: Fields to which the scope rule applies.
       properties:
         fields:
-          description: The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`.
+          description: List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
           example:
             - ""
           items:

api/datadogV2/model_observability_pipeline_sensitive_data_scanner_processor_action_hash.go

@@ -14,7 +14,9 @@ import (
 type ObservabilityPipelineSensitiveDataScannerProcessorActionHash struct {
 	// Action type that replaces the matched sensitive data with a hashed representation, preserving structure while securing content.
 	Action ObservabilityPipelineSensitiveDataScannerProcessorActionHashAction `json:"action"`
-	// The `ObservabilityPipelineSensitiveDataScannerProcessorActionHash` `options`.
+	// Optional settings for the hash action. When omitted or empty, matched sensitive data is
+	// replaced with a deterministic hashed value that preserves structure for analytics while
+	// protecting the original content. Reserved for future hash configuration (for example, algorithm or salt).
 	Options interface{} `json:"options,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_observability_pipeline_sensitive_data_scanner_processor_action_partial_redact_options.go

@@ -12,7 +12,7 @@ import (
 
 // ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions Controls how partial redaction is applied, including character count and direction.
 type ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions struct {
-	// The `ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptions` `characters`.
+	// Number of characters to leave visible from the start or end of the matched value; the rest are redacted.
 	Characters int64 `json:"characters"`
 	// Indicates whether to redact characters from the first or last part of the matched value.
 	Direction ObservabilityPipelineSensitiveDataScannerProcessorActionPartialRedactOptionsDirection `json:"direction"`

api/datadogV2/model_observability_pipeline_sensitive_data_scanner_processor_action_redact_options.go

@@ -12,7 +12,7 @@ import (
 
 // ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions Configuration for fully redacting sensitive data.
 type ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions struct {
-	// The `ObservabilityPipelineSensitiveDataScannerProcessorActionRedactOptions` `replace`.
+	// The string used to replace matched sensitive data (for example, "***" or "[REDACTED]").
 	Replace string `json:"replace"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`

api/datadogV2/model_observability_pipeline_sensitive_data_scanner_processor_rule.go

@@ -23,7 +23,7 @@ type ObservabilityPipelineSensitiveDataScannerProcessorRule struct {
 	// Determines which parts of the log the pattern-matching rule should be applied to.
 	Scope ObservabilityPipelineSensitiveDataScannerProcessorScope `json:"scope"`
 	// Tags assigned to this rule for filtering and classification.
-	Tags []string `json:"tags"`
+	Tags []string `json:"tags,omitempty"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`
 	AdditionalProperties map[string]interface{} `json:"-"`
@@ -33,13 +33,12 @@ type ObservabilityPipelineSensitiveDataScannerProcessorRule struct {
 // This constructor will assign default values to properties that have it defined,
 // and makes sure properties required by API are set, but the set of arguments
 // will change when the set of required properties is changed.
-func NewObservabilityPipelineSensitiveDataScannerProcessorRule(name string, onMatch ObservabilityPipelineSensitiveDataScannerProcessorAction, pattern ObservabilityPipelineSensitiveDataScannerProcessorPattern, scope ObservabilityPipelineSensitiveDataScannerProcessorScope, tags []string) *ObservabilityPipelineSensitiveDataScannerProcessorRule {
+func NewObservabilityPipelineSensitiveDataScannerProcessorRule(name string, onMatch ObservabilityPipelineSensitiveDataScannerProcessorAction, pattern ObservabilityPipelineSensitiveDataScannerProcessorPattern, scope ObservabilityPipelineSensitiveDataScannerProcessorScope) *ObservabilityPipelineSensitiveDataScannerProcessorRule {
 	this := ObservabilityPipelineSensitiveDataScannerProcessorRule{}
 	this.Name = name
 	this.OnMatch = onMatch
 	this.Pattern = pattern
 	this.Scope = scope
-	this.Tags = tags
 	return &this
 }
 
@@ -171,25 +170,30 @@ func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) SetScope(v Obse
 	o.Scope = v
 }
 
-// GetTags returns the Tags field value.
+// GetTags returns the Tags field value if set, zero value otherwise.
 func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) GetTags() []string {
-	if o == nil {
+	if o == nil || o.Tags == nil {
 		var ret []string
 		return ret
 	}
 	return o.Tags
 }
 
-// GetTagsOk returns a tuple with the Tags field value
+// GetTagsOk returns a tuple with the Tags field value if set, nil otherwise
 // and a boolean to check if the value has been set.
 func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) GetTagsOk() (*[]string, bool) {
-	if o == nil {
+	if o == nil || o.Tags == nil {
 		return nil, false
 	}
 	return &o.Tags, true
 }
 
-// SetTags sets field value.
+// HasTags returns a boolean if a field has been set.
+func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) HasTags() bool {
+	return o != nil && o.Tags != nil
+}
+
+// SetTags gets a reference to the given []string and assigns it to the Tags field.
 func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) SetTags(v []string) {
 	o.Tags = v
 }
@@ -207,7 +211,9 @@ func (o ObservabilityPipelineSensitiveDataScannerProcessorRule) MarshalJSON() ([
 	toSerialize["on_match"] = o.OnMatch
 	toSerialize["pattern"] = o.Pattern
 	toSerialize["scope"] = o.Scope
-	toSerialize["tags"] = o.Tags
+	if o.Tags != nil {
+		toSerialize["tags"] = o.Tags
+	}
 
 	for key, value := range o.AdditionalProperties {
 		toSerialize[key] = value
@@ -223,7 +229,7 @@ func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) UnmarshalJSON(b
 		OnMatch        *ObservabilityPipelineSensitiveDataScannerProcessorAction         `json:"on_match"`
 		Pattern        *ObservabilityPipelineSensitiveDataScannerProcessorPattern        `json:"pattern"`
 		Scope          *ObservabilityPipelineSensitiveDataScannerProcessorScope          `json:"scope"`
-		Tags           *[]string                                                         `json:"tags"`
+		Tags           []string                                                          `json:"tags,omitempty"`
 	}{}
 	if err = datadog.Unmarshal(bytes, &all); err != nil {
 		return datadog.Unmarshal(bytes, &o.UnparsedObject)
@@ -240,9 +246,6 @@ func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) UnmarshalJSON(b
 	if all.Scope == nil {
 		return fmt.Errorf("required field scope missing")
 	}
-	if all.Tags == nil {
-		return fmt.Errorf("required field tags missing")
-	}
 	additionalProperties := make(map[string]interface{})
 	if err = datadog.Unmarshal(bytes, &additionalProperties); err == nil {
 		datadog.DeleteKeys(additionalProperties, &[]string{"keyword_options", "name", "on_match", "pattern", "scope", "tags"})
@@ -259,7 +262,7 @@ func (o *ObservabilityPipelineSensitiveDataScannerProcessorRule) UnmarshalJSON(b
 	o.OnMatch = *all.OnMatch
 	o.Pattern = *all.Pattern
 	o.Scope = *all.Scope
-	o.Tags = *all.Tags
+	o.Tags = all.Tags
 
 	if len(additionalProperties) > 0 {
 		o.AdditionalProperties = additionalProperties

api/datadogV2/model_observability_pipeline_sensitive_data_scanner_processor_scope_options.go

@@ -12,7 +12,7 @@ import (
 
 // ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions Fields to which the scope rule applies.
 type ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions struct {
-	// The `ObservabilityPipelineSensitiveDataScannerProcessorScopeOptions` `fields`.
+	// List of log attribute names (field paths) to which the scope applies. Only these fields are included in or excluded from pattern matching.
 	Fields []string `json:"fields"`
 	// UnparsedObject contains the raw value of the object if there was an error when deserializing into the struct
 	UnparsedObject       map[string]interface{} `json:"-"`