datadog_api_client 2.51.0 → 2.52.0

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_commit.rb

@@ -17,29 +17,29 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Metadata about the commit associated with the SCA scan, including author, committer, and branch information.
   class ScaRequestDataAttributesCommit
     include BaseGenericModel
 
-    #
+    # The date when the commit was authored.
     attr_accessor :author_date
 
-    #
+    # The email address of the commit author.
     attr_accessor :author_email
 
-    #
+    # The full name of the commit author.
     attr_accessor :author_name
 
-    #
+    # The branch name on which the commit was made.
     attr_accessor :branch
 
-    #
+    # The email address of the person who committed the change.
     attr_accessor :committer_email
 
-    #
+    # The full name of the person who committed the change.
     attr_accessor :committer_name
 
-    #
+    # The SHA hash uniquely identifying the commit.
     attr_accessor :sha
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_dependencies_items.rb

@@ -17,41 +17,41 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A dependency found in the repository, including its identity, location, and reachability metadata.
   class ScaRequestDataAttributesDependenciesItems
     include BaseGenericModel
 
-    #
+    # A list of patterns or identifiers that should be excluded from analysis for this dependency.
     attr_accessor :exclusions
 
-    #
+    # The group or organization namespace of the dependency (e.g., Maven group ID).
     attr_accessor :group
 
-    #
+    # Indicates whether this is a development-only dependency not used in production.
     attr_accessor :is_dev
 
-    #
+    # Indicates whether this is a direct dependency (as opposed to a transitive one).
     attr_accessor :is_direct
 
-    #
+    # The programming language ecosystem of this dependency (e.g., java, python, javascript).
     attr_accessor :language
 
-    #
+    # The list of source file locations where this dependency is declared.
     attr_accessor :locations
 
-    #
+    # The name of the dependency package.
     attr_accessor :name
 
-    #
+    # The package manager responsible for this dependency (e.g., maven, pip, npm).
     attr_accessor :package_manager
 
-    #
+    # The Package URL (PURL) uniquely identifying this dependency.
     attr_accessor :purl
 
-    #
+    # Properties describing symbols from this dependency that are reachable in the application code.
     attr_accessor :reachable_symbol_properties
 
-    #
+    # The version of the dependency.
     attr_accessor :version
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_dependencies_items_locations_items.rb

@@ -17,20 +17,20 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The source code location where a dependency is declared, including block, name, namespace, and version positions within the file.
   class ScaRequestDataAttributesDependenciesItemsLocationsItems
     include BaseGenericModel
 
-    #
+    # A range within a file defined by a start and end position, along with the file name.
     attr_accessor :block
 
-    #
+    # A range within a file defined by a start and end position, along with the file name.
     attr_accessor :name
 
-    #
+    # A range within a file defined by a start and end position, along with the file name.
     attr_accessor :namespace
 
-    #
+    # A range within a file defined by a start and end position, along with the file name.
     attr_accessor :version
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_dependencies_items_locations_items_file_position.rb

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A range within a file defined by a start and end position, along with the file name.
   class ScaRequestDataAttributesDependenciesItemsLocationsItemsFilePosition
     include BaseGenericModel
 
-    #
+    # A specific position (line and column) within a source file.
     attr_accessor :_end
 
-    #
+    # The name or path of the file containing this location.
     attr_accessor :file_name
 
-    #
+    # A specific position (line and column) within a source file.
     attr_accessor :start
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_dependencies_items_locations_items_position.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A specific position (line and column) within a source file.
   class ScaRequestDataAttributesDependenciesItemsLocationsItemsPosition
     include BaseGenericModel
 
-    #
+    # The column number of the position within the line.
     attr_reader :col
 
-    #
+    # The line number of the position within the file.
     attr_reader :line
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_dependencies_items_reachable_symbol_properties_items.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A key-value property describing a reachable symbol within a dependency.
   class ScaRequestDataAttributesDependenciesItemsReachableSymbolPropertiesItems
     include BaseGenericModel
 
-    #
+    # The name of the reachable symbol property.
     attr_accessor :name
 
-    #
+    # The value of the reachable symbol property.
     attr_accessor :value
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_files_items.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A file entry in the repository associated with a dependency manifest.
   class ScaRequestDataAttributesFilesItems
     include BaseGenericModel
 
-    #
+    # The name or path of the file within the repository.
     attr_accessor :name
 
-    #
+    # The Package URL (PURL) associated with the dependency declared in this file.
     attr_accessor :purl
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_relations_items.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A dependency relation describing which other components a given component depends on.
   class ScaRequestDataAttributesRelationsItems
     include BaseGenericModel
 
-    #
+    # The list of BOM references that this component directly depends on.
     attr_accessor :depends_on
 
-    #
+    # The BOM reference of the component that has dependencies.
     attr_accessor :ref
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_repository.rb

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Information about the source code repository being analyzed.
   class ScaRequestDataAttributesRepository
     include BaseGenericModel
 
-    #
+    # The URL of the repository.
     attr_accessor :url
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_vulnerabilities_items.rb

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A vulnerability entry from the Software Bill of Materials (SBOM), describing a known security issue and the components it affects.
   class ScaRequestDataAttributesVulnerabilitiesItems
     include BaseGenericModel
 
-    #
+    # The list of components affected by this vulnerability.
     attr_accessor :affects
 
-    #
+    # The unique BOM reference identifier for this vulnerability entry.
     attr_accessor :bom_ref
 
-    #
+    # The vulnerability identifier (e.g., CVE ID or similar).
     attr_accessor :id
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_attributes_vulnerabilities_items_affects_items.rb

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A reference to a component affected by a vulnerability.
   class ScaRequestDataAttributesVulnerabilitiesItemsAffectsItems
     include BaseGenericModel
 
-    #
+    # The BOM reference identifying the affected component.
     attr_accessor :ref
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/sca_request_data_type.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The type identifier for SCA dependency analysis requests.
   class ScaRequestDataType
     include BaseEnumModel
 

data/lib/datadog_api_client/v2/models/seat_user_data.rb

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A seat user resource object containing its ID, type, and associated attributes.
   class SeatUserData
     include BaseGenericModel
 
-    #
+    # Attributes of a user assigned to a seat, including their email, name, and assignment timestamp.
     attr_accessor :attributes
 
     # The ID of the seat user.

data/lib/datadog_api_client/v2/models/seat_user_data_array.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A paginated list of seat user resources with associated pagination metadata.
   class SeatUserDataArray
     include BaseGenericModel
 
     # The list of seat users.
     attr_accessor :data
 
-    #
+    # Pagination metadata for the seat users list response.
     attr_accessor :meta
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/seat_user_data_attributes.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes of a user assigned to a seat, including their email, name, and assignment timestamp.
   class SeatUserDataAttributes
     include BaseGenericModel
 

data/lib/datadog_api_client/v2/models/seat_user_meta.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Pagination metadata for the seat users list response.
   class SeatUserMeta
     include BaseGenericModel
 

data/lib/datadog_api_client/v2/models/secret_rule_array.rb

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A collection of secret detection rules returned by the list endpoint.
   class SecretRuleArray
     include BaseGenericModel
 
-    #
+    # The list of secret detection rules.
     attr_reader :data
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/secret_rule_data.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The data object representing a secret detection rule, including its attributes and resource type.
   class SecretRuleData
     include BaseGenericModel
 
-    #
+    # The attributes of a secret detection rule, including its pattern, priority, and validation configuration.
     attr_accessor :attributes
 
-    #
+    # The unique identifier of the secret rule resource.
     attr_accessor :id
 
     # Secret rule resource type.

data/lib/datadog_api_client/v2/models/secret_rule_data_attributes.rb

@@ -17,35 +17,35 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The attributes of a secret detection rule, including its pattern, priority, and validation configuration.
   class SecretRuleDataAttributes
     include BaseGenericModel
 
-    #
+    # A list of keywords that are included by default when scanning for secrets matching this rule.
     attr_accessor :default_included_keywords
 
-    #
+    # A detailed explanation of what type of secret this rule detects.
     attr_accessor :description
 
-    #
+    # The license under which this secret rule is distributed.
     attr_accessor :license
 
-    #
+    # Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response.
     attr_accessor :match_validation
 
-    #
+    # The unique name of the secret detection rule.
     attr_accessor :name
 
-    #
+    # The regular expression pattern used to identify potential secrets in source code or configuration.
     attr_accessor :pattern
 
-    #
+    # The priority level of this rule, used to rank findings when multiple rules match.
     attr_accessor :priority
 
-    #
+    # The identifier of the corresponding Sensitive Data Scanner rule, if one exists.
     attr_accessor :sds_id
 
-    #
+    # A list of validator identifiers used to further confirm a detected secret is genuine.
     attr_accessor :validators
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/secret_rule_data_attributes_match_validation.rb

@@ -17,32 +17,32 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Configuration for validating whether a detected secret is active by making an HTTP request and inspecting the response.
   class SecretRuleDataAttributesMatchValidation
     include BaseGenericModel
 
-    #
+    # The URL endpoint to call when validating a detected secret.
     attr_accessor :endpoint
 
-    #
+    # The list of hostnames to include when performing secret match validation.
     attr_accessor :hosts
 
-    #
+    # The HTTP method (e.g., GET, POST) to use when making the validation request.
     attr_accessor :http_method
 
-    #
+    # The HTTP status code ranges that indicate the detected secret is invalid or inactive.
     attr_accessor :invalid_http_status_code
 
-    #
+    # A map of HTTP header names to values to include in the validation request.
     attr_accessor :request_headers
 
-    #
+    # The maximum number of seconds to wait for a response during validation before timing out.
     attr_reader :timeout_seconds
 
-    #
+    # The type of match validation to perform (e.g., http).
     attr_accessor :type
 
-    #
+    # The HTTP status code ranges that indicate the detected secret is valid and active.
     attr_accessor :valid_http_status_code
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/secret_rule_data_attributes_match_validation_invalid_http_status_code_items.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # An HTTP status code range that indicates an invalid (unsuccessful) secret match during validation.
   class SecretRuleDataAttributesMatchValidationInvalidHttpStatusCodeItems
     include BaseGenericModel
 
-    #
+    # The inclusive upper bound of the HTTP status code range.
     attr_reader :_end
 
-    #
+    # The inclusive lower bound of the HTTP status code range.
     attr_reader :start
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/secret_rule_data_attributes_match_validation_valid_http_status_code_items.rb

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # An HTTP status code range that indicates a valid (successful) secret match during validation.
   class SecretRuleDataAttributesMatchValidationValidHttpStatusCodeItems
     include BaseGenericModel
 
-    #
+    # The inclusive upper bound of the HTTP status code range.
     attr_reader :_end
 
-    #
+    # The inclusive lower bound of the HTTP status code range.
     attr_reader :start
 
     attr_accessor :additional_properties

data/lib/datadog_api_client/v2/models/security_entity_risk_scores_response.rb

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class SecurityEntityRiskScoresResponse
     include BaseGenericModel
 
-    #
+    # Array of entity risk score objects.
     attr_reader :data
 
     # Metadata for pagination

data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_attributes.rb

@@ -39,7 +39,7 @@ module DatadogAPIClient::V2
     # The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
     attr_accessor :rule_query
 
-    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased.
+    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op).
     attr_accessor :severity
 
     # List of tags associated with the critical asset.

data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_create_attributes.rb

@@ -30,7 +30,7 @@ module DatadogAPIClient::V2
     # The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
     attr_reader :rule_query
 
-    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased.
+    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op).
     attr_reader :severity
 
     # List of tags associated with the critical asset.

data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_severity.rb

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased.
+  # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op).
   class SecurityMonitoringCriticalAssetSeverity
     include BaseEnumModel
 
@@ -28,5 +28,6 @@ module DatadogAPIClient::V2
     CRITICAL = "critical".freeze
     INCREASE = "increase".freeze
     DECREASE = "decrease".freeze
+    NO_OP = "no-op".freeze
   end
 end

data/lib/datadog_api_client/v2/models/security_monitoring_critical_asset_update_attributes.rb

@@ -30,7 +30,7 @@ module DatadogAPIClient::V2
     # The rule query of the critical asset, with the same syntax as the search bar for detection rules. This determines which rules this critical asset will apply to.
     attr_accessor :rule_query
 
-    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased.
+    # Severity associated with this critical asset. Either an explicit severity can be set, or the severity can be increased or decreased, or the severity can be left unchanged (no-op).
     attr_accessor :severity
 
     # List of tags associated with the critical asset.

data/lib/datadog_api_client/v2/models/security_monitoring_signal_archive_reason.rb

@@ -24,6 +24,7 @@ module DatadogAPIClient::V2
     NONE = "none".freeze
     FALSE_POSITIVE = "false_positive".freeze
     TESTING_OR_MAINTENANCE = "testing_or_maintenance".freeze
+    REMEDIATED = "remediated".freeze
     INVESTIGATED_CASE_OPENED = "investigated_case_opened".freeze
     TRUE_POSITIVE_BENIGN = "true_positive_benign".freeze
     TRUE_POSITIVE_MALICIOUS = "true_positive_malicious".freeze