datadog_api_client 2.51.0 → 2.52.0

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

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class Findings
     include BaseGenericModel
 
-    #
+    # Array of security finding data objects.
     attr_accessor :data
 
     attr_accessor :additional_properties

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

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A key-value pair representing a tag associated with a Datadog Agent.
   class FleetAgentAttributesTagsItems
     include BaseGenericModel
 
-    #
+    # The tag key.
     attr_accessor :key
 
-    #
+    # The tag value.
     attr_accessor :value
 
     attr_accessor :additional_properties

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

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class FleetAgentVersion
     include BaseGenericModel
 
-    #
+    # Attributes of an available Datadog Agent version.
     attr_accessor :attributes
 
     # Unique identifier for the Agent version (same as version).

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes of an available Datadog Agent version.
   class FleetAgentVersionAttributes
     include BaseGenericModel
 

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

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class FleetAgentsResponseData
     include BaseGenericModel
 
-    #
+    # Attributes of the fleet agents response containing the list of agents.
     attr_reader :attributes
 
     # Status identifier.

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes of the fleet agents response containing the list of agents.
   class FleetAgentsResponseDataAttributes
     include BaseGenericModel
 

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Response containing the entity attribute mapping configuration including all available attributes and their properties.
   class GetMappingResponse
     include BaseGenericModel
 
-    #
+    # The data object containing the resource type and attributes for the get mapping response.
     attr_accessor :data
 
     attr_accessor :additional_properties

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

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The data object containing the resource type and attributes for the get mapping response.
   class GetMappingResponseData
     include BaseGenericModel
 
-    #
+    # Attributes of the get mapping response, containing the list of configured entity attributes.
     attr_accessor :attributes
 
-    #
+    # Unique identifier for the get mapping response resource.
     attr_accessor :id
 
     # Get mappings response resource type.

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes of the get mapping response, containing the list of configured entity attributes.
   class GetMappingResponseDataAttributes
     include BaseGenericModel
 
-    #
+    # The list of entity attributes and their mapping configurations.
     attr_accessor :attributes
 
     attr_accessor :additional_properties

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

@@ -17,26 +17,26 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Details of a single entity attribute including its mapping configuration and metadata.
   class GetMappingResponseDataAttributesAttributesItems
     include BaseGenericModel
 
-    #
+    # The attribute identifier as used in the entity data model.
     attr_accessor :attribute
 
-    #
+    # Human-readable explanation of what the attribute represents.
     attr_accessor :description
 
-    #
+    # The human-readable label for the attribute shown in the UI.
     attr_accessor :display_name
 
-    #
+    # List of group labels used to categorize the attribute.
     attr_accessor :groups
 
-    #
+    # Whether this attribute is a custom user-defined attribute rather than a built-in one.
     attr_accessor :is_custom
 
-    #
+    # The data type of the attribute (for example, string or number).
     attr_accessor :type
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The request payload for retrieving rules for multiple rulesets in a single batch call.
   class GetMultipleRulesetsRequest
     include BaseGenericModel
 
-    #
+    # The primary data object in the get-multiple-rulesets request, containing request attributes and resource type.
     attr_accessor :data
 
     attr_accessor :additional_properties

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

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The primary data object in the get-multiple-rulesets request, containing request attributes and resource type.
   class GetMultipleRulesetsRequestData
     include BaseGenericModel
 
-    #
+    # The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include.
     attr_accessor :attributes
 
-    #
+    # An optional identifier for the get-multiple-rulesets request resource.
     attr_accessor :id
 
     # Get multiple rulesets request resource type.

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

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The request attributes for fetching multiple rulesets, specifying which rulesets to retrieve and what data to include.
   class GetMultipleRulesetsRequestDataAttributes
     include BaseGenericModel
 
-    #
+    # When true, rules that are available in testing mode are included in the response.
     attr_accessor :include_testing_rules
 
-    #
+    # When true, test cases associated with each rule are included in the response.
     attr_accessor :include_tests
 
-    #
+    # The list of ruleset names to retrieve.
     attr_accessor :rulesets
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The response payload for the get-multiple-rulesets endpoint, containing the requested rulesets and their rules.
   class GetMultipleRulesetsResponse
     include BaseGenericModel
 
-    #
+    # The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type.
     attr_accessor :data
 
     attr_accessor :additional_properties

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

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The primary data object in the get-multiple-rulesets response, containing the response attributes and resource type.
   class GetMultipleRulesetsResponseData
     include BaseGenericModel
 
-    #
+    # The attributes of the get-multiple-rulesets response, containing the list of requested rulesets.
     attr_accessor :attributes
 
-    #
+    # The unique identifier of the get-multiple-rulesets response resource.
     attr_accessor :id
 
     # Get multiple rulesets response resource type.

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The attributes of the get-multiple-rulesets response, containing the list of requested rulesets.
   class GetMultipleRulesetsResponseDataAttributes
     include BaseGenericModel
 
-    #
+    # The list of rulesets returned in response to the batch request.
     attr_accessor :rulesets
 
     attr_accessor :additional_properties

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

@@ -17,23 +17,23 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A ruleset returned in the response, containing its metadata and associated rules.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItems
     include BaseGenericModel
 
-    #
+    # The resource identifier and type for a ruleset.
     attr_reader :data
 
-    #
+    # A detailed description of the ruleset's purpose and the types of issues it targets.
     attr_accessor :description
 
-    #
+    # The unique name of the ruleset.
     attr_accessor :name
 
-    #
+    # The list of static analysis rules included in this ruleset.
     attr_accessor :rules
 
-    #
+    # A brief summary of the ruleset, suitable for display in listings.
     attr_accessor :short_description
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The resource identifier and type for a ruleset.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItemsData
     include BaseGenericModel
 
-    #
+    # The unique identifier of the ruleset resource.
     attr_accessor :id
 
     # Rulesets resource type.

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

@@ -17,83 +17,83 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A static analysis rule within a ruleset, including its definition, metadata, and associated test cases.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItems
     include BaseGenericModel
 
-    #
+    # The list of configurable arguments accepted by this rule.
     attr_accessor :arguments
 
-    #
+    # The category classifying the type of issue this rule detects (e.g., security, style, performance).
     attr_accessor :category
 
-    #
+    # A checksum of the rule definition used to detect changes.
     attr_accessor :checksum
 
-    #
+    # The rule implementation code used by the static analysis engine.
     attr_accessor :code
 
-    #
+    # The date and time when the rule was created.
     attr_accessor :created_at
 
-    #
+    # The identifier of the user or system that created the rule.
     attr_accessor :created_by
 
-    #
+    # The CVE identifier associated with the vulnerability this rule detects, if applicable.
     attr_accessor :cve
 
-    #
+    # The CWE identifier associated with the weakness category this rule detects, if applicable.
     attr_accessor :cwe
 
-    #
+    # The resource identifier and type for a static analysis rule.
     attr_reader :data
 
-    #
+    # A detailed explanation of what the rule detects and why it matters.
     attr_accessor :description
 
-    #
+    # A URL pointing to additional documentation for this rule.
     attr_accessor :documentation_url
 
-    #
+    # The code entity type (e.g., function, class, variable) that this rule inspects.
     attr_accessor :entity_checked
 
-    #
+    # Indicates whether the rule is publicly published and available to all users.
     attr_accessor :is_published
 
-    #
+    # Indicates whether the rule is in testing mode and not yet promoted to production.
     attr_accessor :is_testing
 
-    #
+    # The programming language this rule applies to.
     attr_accessor :language
 
-    #
+    # The date and time when the rule was last modified.
     attr_accessor :last_updated_at
 
-    #
+    # The identifier of the user or system that last updated the rule.
     attr_accessor :last_updated_by
 
-    #
+    # The unique name identifying this rule within its ruleset.
     attr_accessor :name
 
-    #
+    # A regular expression pattern used by the rule for pattern-based detection.
     attr_accessor :regex
 
-    #
+    # The severity level of findings produced by this rule (e.g., ERROR, WARNING, NOTICE).
     attr_accessor :severity
 
-    #
+    # A brief summary of what the rule detects, suitable for display in listings.
     attr_accessor :short_description
 
-    #
+    # Indicates whether an AI-generated fix suggestion should be offered for findings from this rule.
     attr_accessor :should_use_ai_fix
 
-    #
+    # The list of test cases used to validate the rule's behavior.
     attr_accessor :tests
 
-    #
+    # The Tree-sitter query expression used by the rule to match code patterns in the AST.
     attr_accessor :tree_sitter_query
 
-    #
+    # The rule type indicating the detection mechanism used (e.g., tree_sitter, regex).
     attr_accessor :type
 
     attr_accessor :additional_properties

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

@@ -17,14 +17,14 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # An argument parameter for a static analysis rule, with a name and description.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsArgumentsItems
     include BaseGenericModel
 
-    #
+    # A human-readable explanation of the argument's purpose and accepted values.
     attr_accessor :description
 
-    #
+    # The name of the rule argument.
     attr_accessor :name
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # The resource identifier and type for a static analysis rule.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsData
     include BaseGenericModel
 
-    #
+    # The unique identifier of the rule resource.
     attr_accessor :id
 
     # Rules resource type.

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

@@ -17,17 +17,17 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # A test case associated with a static analysis rule, containing the source code and expected annotation count.
   class GetMultipleRulesetsResponseDataAttributesRulesetsItemsRulesItemsTestsItems
     include BaseGenericModel
 
-    #
+    # The expected number of annotations (findings) the rule should produce when run against the test code.
     attr_reader :annotation_count
 
-    #
+    # The source code snippet used as input for the rule test.
     attr_accessor :code
 
-    #
+    # The filename associated with the test code snippet.
     attr_accessor :filename
 
     attr_accessor :additional_properties

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object in the global incident settings request.
   class GlobalIncidentSettingsDataRequest
     include BaseGenericModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object in the global incident settings response.
   class GlobalIncidentSettingsDataResponse
     include BaseGenericModel
 

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Request payload for updating global incident settings.
   class GlobalIncidentSettingsRequest
     include BaseGenericModel
 
-    #
+    # Data object in the global incident settings request.
     attr_reader :data
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Response payload containing global incident settings.
   class GlobalIncidentSettingsResponse
     include BaseGenericModel
 
-    #
+    # Data object in the global incident settings response.
     attr_reader :data
 
     attr_accessor :additional_properties

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

@@ -21,7 +21,7 @@ module DatadogAPIClient::V2
   class GlobalVariableJsonPatchRequest
     include BaseGenericModel
 
-    #
+    # Data object for a JSON Patch request on a Synthetic global variable.
     attr_reader :data
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object for a JSON Patch request on a Synthetic global variable.
   class GlobalVariableJsonPatchRequestData
     include BaseGenericModel
 
-    #
+    # Attributes for a JSON Patch request on a Synthetic global variable.
     attr_accessor :attributes
 
     # Global variable JSON Patch type.

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes for a JSON Patch request on a Synthetic global variable.
   class GlobalVariableJsonPatchRequestDataAttributes
     include BaseGenericModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes for a HAMR organization connection request.
   class HamrOrgConnectionAttributesRequest
     include BaseGenericModel
 

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Attributes of a HAMR organization connection response.
   class HamrOrgConnectionAttributesResponse
     include BaseGenericModel
 

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object for a HAMR organization connection request.
   class HamrOrgConnectionDataRequest
     include BaseGenericModel
 
-    #
+    # Attributes for a HAMR organization connection request.
     attr_reader :attributes
 
     # The organization UUID for this HAMR connection. Must match the authenticated organization's UUID.

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object for a HAMR organization connection response.
   class HamrOrgConnectionDataResponse
     include BaseGenericModel
 
-    #
+    # Attributes of a HAMR organization connection response.
     attr_reader :attributes
 
     # The organization UUID for this HAMR connection.

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Request payload for creating or updating a HAMR organization connection.
   class HamrOrgConnectionRequest
     include BaseGenericModel
 
-    #
+    # Data object for a HAMR organization connection request.
     attr_reader :data
 
     attr_accessor :additional_properties

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

@@ -17,11 +17,11 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Response payload for a HAMR organization connection.
   class HamrOrgConnectionResponse
     include BaseGenericModel
 
-    #
+    # Data object for a HAMR organization connection response.
     attr_reader :data
 
     attr_accessor :additional_properties

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

@@ -17,7 +17,7 @@ require 'date'
 require 'time'
 
 module DatadogAPIClient::V2
-  # 
+  # Data object representing an incident handle in a create or update request.
   class IncidentHandleDataRequest
     include BaseGenericModel
 
@@ -27,7 +27,7 @@ module DatadogAPIClient::V2
     # The ID of the incident handle (required for PUT requests)
     attr_accessor :id
 
-    #
+    # Relationships to associate with an incident handle in a create or update request.
     attr_accessor :relationships
 
     # Incident handle resource type