Regenerate client from commit 3d683e08 of spec repo

ci.datadog-api-spec · ci.datadog-api-spec · commit 30caf728e357 · 2025-01-23T15:34:20.000Z
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-22 15:54:16.616972",
-            "spec_repo_commit": "7a8ea4b1"
+            "regenerated": "2025-01-23 15:33:51.890975",
+            "spec_repo_commit": "3d683e08"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-22 15:54:16.633227",
-            "spec_repo_commit": "7a8ea4b1"
+            "regenerated": "2025-01-23 15:33:51.906081",
+            "spec_repo_commit": "3d683e08"
         }
     }
 }
diff --git a/.generator/schemas/v2/openapi.yaml b/.generator/schemas/v2/openapi.yaml
@@ -12666,6 +12666,20 @@ components:
             $ref: '#/components/schemas/GetInterfacesData'
           type: array
       type: object
+    GetRuleVersionHistoryResponse:
+      description: Response object containing the version history of a rule.
+      properties:
+        count:
+          description: The number of rule versions.
+          format: int32
+          maximum: 2147483647
+          type: integer
+        data:
+          description: A list of rule versions.
+          items:
+            $ref: '#/components/schemas/RuleVersionHistory'
+          type: array
+      type: object
     GetSBOMResponse:
       description: The expected response schema when getting an SBOM.
       properties:
@@ -22930,6 +22944,42 @@ components:
       type: string
       x-enum-varnames:
       - RULE
+    RuleVersionHistory:
+      description: A rule version with a list of updates.
+      properties:
+        changes:
+          description: A list of changes.
+          items:
+            $ref: '#/components/schemas/RuleVersionUpdate'
+          type: array
+        rule:
+          $ref: '#/components/schemas/SecurityMonitoringRuleResponse'
+      type: object
+    RuleVersionUpdate:
+      description: A change in a rule version.
+      properties:
+        change:
+          description: The new value of the field.
+          example: cloud_provider:aws
+          type: string
+        field:
+          description: The field that was changed.
+          example: Tags
+          type: string
+        type:
+          $ref: '#/components/schemas/RuleVersionUpdateType'
+      type: object
+    RuleVersionUpdateType:
+      description: The type of change.
+      enum:
+      - create
+      - update
+      - delete
+      type: string
+      x-enum-varnames:
+      - CREATE
+      - UPDATE
+      - DELETE
     RumMetricCompute:
       description: The compute rule to compute the rum-based metric.
       properties:
@@ -44751,6 +44801,42 @@ paths:
         operator: OR
         permissions:
         - security_monitoring_rules_write
+  /api/v2/security_monitoring/rules/{rule_id}/version_history:
+    get:
+      description: Get a rule's version history.
+      operationId: GetRuleVersionHistory
+      parameters:
+      - $ref: '#/components/parameters/SecurityMonitoringRuleID'
+      - $ref: '#/components/parameters/PageSize'
+      - $ref: '#/components/parameters/PageNumber'
+      responses:
+        '200':
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/GetRuleVersionHistoryResponse'
+          description: OK
+        '400':
+          $ref: '#/components/responses/BadRequestResponse'
+        '403':
+          $ref: '#/components/responses/NotAuthorizedResponse'
+        '404':
+          $ref: '#/components/responses/NotFoundResponse'
+        '429':
+          $ref: '#/components/responses/TooManyRequestsResponse'
+      security:
+      - apiKeyAuth: []
+        appKeyAuth: []
+      - AuthZ:
+        - security_monitoring_rules_read
+      summary: Get a rule's version history
+      tags:
+      - Security Monitoring
+      x-permission:
+        operator: OR
+        permissions:
+        - security_monitoring_rules_read
+      x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.'
   /api/v2/security_monitoring/signals:
     get:
       description: 'The list endpoint returns security signals that match a search
diff --git a/cassettes/features/v2/security_monitoring/Get-rule-version-history-returns-OK-response.frozen b/cassettes/features/v2/security_monitoring/Get-rule-version-history-returns-OK-response.frozen
@@ -0,0 +1 @@
+2025-01-22T19:09:57.587Z
diff --git a/cassettes/features/v2/security_monitoring/Get-rule-version-history-returns-OK-response.yml b/cassettes/features/v2/security_monitoring/Get-rule-version-history-returns-OK-response.yml
diff --git a/examples/v2/security-monitoring/GetRuleVersionHistory.rb b/examples/v2/security-monitoring/GetRuleVersionHistory.rb
@@ -0,0 +1,8 @@
+# Get a rule's version history returns "OK" response
+
+require "datadog_api_client"
+DatadogAPIClient.configure do |config|
+  config.unstable_operations["v2.get_rule_version_history".to_sym] = true
+end
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+p api_instance.get_rule_version_history("rule_id")
diff --git a/examples/v2/security-monitoring/GetRuleVersionHistory_2467565841.rb b/examples/v2/security-monitoring/GetRuleVersionHistory_2467565841.rb
@@ -0,0 +1,8 @@
+# Get rule version history returns "OK" response
+
+require "datadog_api_client"
+api_instance = DatadogAPIClient::V2::SecurityMonitoringAPI.new
+
+# there is a valid "security_rule" in the system
+SECURITY_RULE_ID = ENV["SECURITY_RULE_ID"]
+p api_instance.get_rule_version_history(SECURITY_RULE_ID)
diff --git a/features/scenarios_model_mapping.rb b/features/scenarios_model_mapping.rb
@@ -1935,6 +1935,11 @@
             "rule_id" => "String",
             "body" => "SecurityMonitoringRuleTestRequest",
     },
+    "v2.GetRuleVersionHistory" => {
+            "rule_id" => "String",
+            "page_size" => "Integer",
+            "page_number" => "Integer",
+    },
     "v2.ListSecurityMonitoringSignals" => {
             "filter_query" => "String",
             "filter_from" => "Time",
diff --git a/features/v2/security_monitoring.feature b/features/v2/security_monitoring.feature
@@ -534,6 +534,30 @@ Feature: Security Monitoring
     And the response "name" is equal to "{{ unique }}"
     And the response "id" has the same value as "security_rule.id"
 
+  @generated @skip @team:DataDog/k9-cloud-security-platform
+  Scenario: Get a rule's version history returns "Bad Request" response
+    Given operation "GetRuleVersionHistory" enabled
+    And new "GetRuleVersionHistory" request
+    And request contains "rule_id" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 400 Bad Request
+
+  @generated @skip @team:DataDog/k9-cloud-security-platform
+  Scenario: Get a rule's version history returns "Not Found" response
+    Given operation "GetRuleVersionHistory" enabled
+    And new "GetRuleVersionHistory" request
+    And request contains "rule_id" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 404 Not Found
+
+  @generated @skip @team:DataDog/k9-cloud-security-platform
+  Scenario: Get a rule's version history returns "OK" response
+    Given operation "GetRuleVersionHistory" enabled
+    And new "GetRuleVersionHistory" request
+    And request contains "rule_id" parameter from "REPLACE.ME"
+    When the request is sent
+    Then the response status is 200 OK
+
   @generated @skip @team:DataDog/k9-cloud-security-platform
   Scenario: Get a security filter returns "Not Found" response
     Given new "GetSecurityFilter" request
@@ -599,6 +623,17 @@ Feature: Security Monitoring
     When the request is sent
     Then the response status is 200 OK
 
+  @replay-only @skip-validation @team:DataDog/k9-cloud-security-platform
+  Scenario: Get rule version history returns "OK" response
+    Given new "GetRuleVersionHistory" request
+    And there is a valid "security_rule" in the system
+    And request contains "rule_id" parameter from "security_rule.id"
+    When the request is sent
+    Then the response status is 200 OK
+    And the response "data.id" has the same value as "security_rule.id"
+    And the response "data.attributes.count" is equal to 1
+    And the response "data.attributes.data[1].rule.name" has the same value as "security_rule.name"
+
   @generated @skip @team:DataDog/cloud-security-posture-management
   Scenario: List findings returns "Bad Request: The server cannot process the request due to invalid syntax in the request." response
     Given operation "ListFindings" enabled
diff --git a/features/v2/undo.json b/features/v2/undo.json
@@ -2251,6 +2251,12 @@
       "type": "idempotent"
     }
   },
+  "GetRuleVersionHistory": {
+    "tag": "Security Monitoring",
+    "undo": {
+      "type": "safe"
+    }
+  },
   "ListSecurityMonitoringSignals": {
     "tag": "Security Monitoring",
     "undo": {
diff --git a/lib/datadog_api_client/configuration.rb b/lib/datadog_api_client/configuration.rb
@@ -246,6 +246,7 @@ def initialize
             "v2.delete_historical_job": false,
             "v2.get_finding": false,
             "v2.get_historical_job": false,
+            "v2.get_rule_version_history": false,
             "v2.get_sbom": false,
             "v2.list_findings": false,
             "v2.list_historical_jobs": false,
diff --git a/lib/datadog_api_client/inflector.rb b/lib/datadog_api_client/inflector.rb
@@ -1652,6 +1652,7 @@ def overrides
           "v2.get_finding_response" => "GetFindingResponse",
           "v2.get_interfaces_data" => "GetInterfacesData",
           "v2.get_interfaces_response" => "GetInterfacesResponse",
+          "v2.get_rule_version_history_response" => "GetRuleVersionHistoryResponse",
           "v2.get_sbom_response" => "GetSBOMResponse",
           "v2.get_team_memberships_sort" => "GetTeamMembershipsSort",
           "v2.group_scalar_column" => "GroupScalarColumn",
@@ -2295,6 +2296,9 @@ def overrides
           "v2.rule_attributes" => "RuleAttributes",
           "v2.rule_outcome_relationships" => "RuleOutcomeRelationships",
           "v2.rule_type" => "RuleType",
+          "v2.rule_version_history" => "RuleVersionHistory",
+          "v2.rule_version_update" => "RuleVersionUpdate",
+          "v2.rule_version_update_type" => "RuleVersionUpdateType",
           "v2.rum_aggregate_bucket_value" => "RUMAggregateBucketValue",
           "v2.rum_aggregate_bucket_value_timeseries_point" => "RUMAggregateBucketValueTimeseriesPoint",
           "v2.rum_aggregate_request" => "RUMAggregateRequest",
diff --git a/lib/datadog_api_client/v2/api/security_monitoring_api.rb b/lib/datadog_api_client/v2/api/security_monitoring_api.rb
@@ -1134,6 +1134,81 @@ def get_historical_job_with_http_info(job_id, opts = {})
       return data, status_code, headers
     end
 
+    # Get a rule's version history.
+    #
+    # @see #get_rule_version_history_with_http_info
+    def get_rule_version_history(rule_id, opts = {})
+      data, _status_code, _headers = get_rule_version_history_with_http_info(rule_id, opts)
+      data
+    end
+
+    # Get a rule's version history.
+    #
+    # Get a rule's version history.
+    #
+    # @param rule_id [String] The ID of the rule.
+    # @param opts [Hash] the optional parameters
+    # @option opts [Integer] :page_size Size for a given page. The maximum allowed value is 100.
+    # @option opts [Integer] :page_number Specific page number to return.
+    # @return [Array<(GetRuleVersionHistoryResponse, Integer, Hash)>] GetRuleVersionHistoryResponse data, response status code and response headers
+    def get_rule_version_history_with_http_info(rule_id, opts = {})
+      unstable_enabled = @api_client.config.unstable_operations["v2.get_rule_version_history".to_sym]
+      if unstable_enabled
+        @api_client.config.logger.warn format("Using unstable operation '%s'", "v2.get_rule_version_history")
+      else
+        raise DatadogAPIClient::APIError.new(message: format("Unstable operation '%s' is disabled", "v2.get_rule_version_history"))
+      end
+
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: SecurityMonitoringAPI.get_rule_version_history ...'
+      end
+      # verify the required parameter 'rule_id' is set
+      if @api_client.config.client_side_validation && rule_id.nil?
+        fail ArgumentError, "Missing the required parameter 'rule_id' when calling SecurityMonitoringAPI.get_rule_version_history"
+      end
+      # resource path
+      local_var_path = '/api/v2/security_monitoring/rules/{rule_id}/version_history'.sub('{rule_id}', CGI.escape(rule_id.to_s).gsub('%2F', '/'))
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+      query_params[:'page[size]'] = opts[:'page_size'] if !opts[:'page_size'].nil?
+      query_params[:'page[number]'] = opts[:'page_number'] if !opts[:'page_number'].nil?
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json'])
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetRuleVersionHistoryResponse'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || [:apiKeyAuth, :appKeyAuth, :AuthZ]
+
+      new_options = opts.merge(
+        :operation => :get_rule_version_history,
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type,
+        :api_version => "V2"
+      )
+
+      data, status_code, headers = @api_client.call_api(Net::HTTP::Get, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: SecurityMonitoringAPI#get_rule_version_history\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
     # Get SBOM.
     #
     # @see #get_sbom_with_http_info
diff --git a/lib/datadog_api_client/v2/models/get_rule_version_history_response.rb b/lib/datadog_api_client/v2/models/get_rule_version_history_response.rb
diff --git a/lib/datadog_api_client/v2/models/rule_version_history.rb b/lib/datadog_api_client/v2/models/rule_version_history.rb
diff --git a/lib/datadog_api_client/v2/models/rule_version_update.rb b/lib/datadog_api_client/v2/models/rule_version_update.rb
diff --git a/lib/datadog_api_client/v2/models/rule_version_update_type.rb b/lib/datadog_api_client/v2/models/rule_version_update_type.rb

Original file line number	Diff line number	Diff line change
`@@ -4,13 +4,13 @@`
`4`	`4`	`"spec_versions": {`
`5`	`5`	`"v1": {`
`6`	`6`	`"apigentools_version": "1.6.6",`
`7`		`- "regenerated": "2025-01-22 15:54:16.616972",`
`8`		`- "spec_repo_commit": "7a8ea4b1"`
	`7`	`+ "regenerated": "2025-01-23 15:33:51.890975",`
	`8`	`+ "spec_repo_commit": "3d683e08"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2025-01-22 15:54:16.633227",`
`13`		`- "spec_repo_commit": "7a8ea4b1"`
	`12`	`+ "regenerated": "2025-01-23 15:33:51.906081",`
	`13`	`+ "spec_repo_commit": "3d683e08"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`