Update retention filters public API (#1798)

Co-authored-by: ci.datadog-api-spec <[email protected]>
Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-10 19:44:57.613520",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:34.930029",
+            "spec_repo_commit": "8ffb168c"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-10 19:44:57.631078",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:34.947335",
+            "spec_repo_commit": "8ffb168c"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -16072,6 +16072,7 @@ components:
       - spans-sampling-processor
       - spans-errors-sampling-processor
       - spans-appsec-sampling-processor
+      example: spans-sampling-processor
       type: string
       x-enum-varnames:
       - SPANS_SAMPLING_PROCESSOR
@@ -16188,11 +16189,42 @@ components:
       type: string
       x-enum-varnames:
       - SPANS_SAMPLING_PROCESSOR
+    RetentionFilterUpdateAttributes:
+      description: The object describing the configuration of the retention filter
+        to create/update.
+      properties:
+        enabled:
+          description: Enable/Disable the retention filter.
+          example: true
+          type: boolean
+        filter:
+          $ref: '#/components/schemas/SpansFilterCreate'
+        filter_type:
+          $ref: '#/components/schemas/RetentionFilterAllType'
+        name:
+          description: The name of the retention filter.
+          example: my retention filter
+          type: string
+        rate:
+          description: 'Sample rate to apply to spans going through this retention
+            filter,
+
+            a value of 1.0 keeps all spans matching the query.'
+          example: 1.0
+          format: double
+          type: number
+      required:
+      - name
+      - filter
+      - enabled
+      - filter_type
+      - rate
+      type: object
     RetentionFilterUpdateData:
       description: The body of the retention filter to be updated.
       properties:
         attributes:
-          $ref: '#/components/schemas/RetentionFilterCreateAttributes'
+          $ref: '#/components/schemas/RetentionFilterUpdateAttributes'
         id:
           description: The ID of the retention filter.
           example: retention-filter-id
@@ -23271,7 +23303,11 @@ paths:
     post:
       description: 'Create a retention filter to index spans in your organization.
 
-        Returns the retention filter definition when the request is successful.'
+        Returns the retention filter definition when the request is successful.
+
+
+        Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+        cannot be created.'
       operationId: CreateApmRetentionFilter
       requestBody:
         content:
@@ -23325,7 +23361,11 @@ paths:
       x-codegen-request-body-name: body
   /api/v2/apm/config/retention-filters/{filter_id}:
     delete:
-      description: Delete a specific retention filter from your organization.
+      description: 'Delete a specific retention filter from your organization.
+
+
+        Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor
+        cannot be deleted.'
       operationId: DeleteApmRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RetentionFilterIdParam'
@@ -23363,7 +23403,11 @@ paths:
       tags:
       - APM Retention Filters
     put:
-      description: Update a retention filter from your organization.
+      description: 'Update a retention filter from your organization.
+
+
+        Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor)
+        cannot be renamed or removed.'
       operationId: UpdateApmRetentionFilter
       parameters:
       - $ref: '#/components/parameters/RetentionFilterIdParam'

cassettes/features/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.frozen

@@ -0,0 +1 @@
+2024-04-10T12:31:19.300Z

cassettes/features/v2/apm_retention_filters/Create-a-default-retention-filter-returns-Bad-Request-response.yml

@@ -8,14 +8,14 @@
 
 body = DatadogAPIClient::V2::RetentionFilterUpdateRequest.new({
   data: DatadogAPIClient::V2::RetentionFilterUpdateData.new({
-    attributes: DatadogAPIClient::V2::RetentionFilterCreateAttributes.new({
+    attributes: DatadogAPIClient::V2::RetentionFilterUpdateAttributes.new({
       name: "test",
       rate: 0.9,
       filter: DatadogAPIClient::V2::SpansFilterCreate.new({
         query: "@_top_level:1 test:service-demo",
       }),
       enabled: true,
-      filter_type: DatadogAPIClient::V2::RetentionFilterType::SPANS_SAMPLING_PROCESSOR,
+      filter_type: DatadogAPIClient::V2::RetentionFilterAllType::SPANS_SAMPLING_PROCESSOR,
     }),
     id: "test-id",
     type: DatadogAPIClient::V2::ApmRetentionFilterType::APM_RETENTION_FILTER,

examples/v2/apm-retention-filters/UpdateApmRetentionFilter.rb

@@ -12,6 +12,13 @@ Feature: APM Retention Filters
     And a valid "appKeyAuth" key in the system
     And an instance of "APMRetentionFilters" API
 
+  @team:DataDog/apm-trace-intake
+  Scenario: Create a default retention filter returns "Bad Request" response
+    Given new "CreateApmRetentionFilter" request
+    And body with value {"data": {"attributes": {"enabled": true, "filter": {"query": "@http.status_code:200 service:my-service"}, "filter_type": "spans-errors-sampling-processor", "name": "my retention filter", "rate": 1.0}, "type": "apm_retention_filter"}}
+    When the request is sent
+    Then the response status is 400 Bad Request
+
   @team:DataDog/apm-trace-intake
   Scenario: Create a retention filter returns "Bad Request" response
     Given new "CreateApmRetentionFilter" request

features/v2/apm_retention_filters.feature

@@ -1825,6 +1825,7 @@ def overrides
           "v2.retention_filter_response" => "RetentionFilterResponse",
           "v2.retention_filters_response" => "RetentionFiltersResponse",
           "v2.retention_filter_type" => "RetentionFilterType",
+          "v2.retention_filter_update_attributes" => "RetentionFilterUpdateAttributes",
           "v2.retention_filter_update_data" => "RetentionFilterUpdateData",
           "v2.retention_filter_update_request" => "RetentionFilterUpdateRequest",
           "v2.retention_filter_without_attributes" => "RetentionFilterWithoutAttributes",

lib/datadog_api_client/inflector.rb

@@ -36,6 +36,8 @@ def create_apm_retention_filter(body, opts = {})
     # Create a retention filter to index spans in your organization.
     # Returns the retention filter definition when the request is successful.
     #
+    # Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be created.
+    #
     # @param body [RetentionFilterCreateRequest] The definition of the new retention filter.
     # @param opts [Hash] the optional parameters
     # @return [Array<(RetentionFilterResponse, Integer, Hash)>] RetentionFilterResponse data, response status code and response headers
@@ -103,6 +105,8 @@ def delete_apm_retention_filter(filter_id, opts = {})
     #
     # Delete a specific retention filter from your organization.
     #
+    # Default filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor cannot be deleted.
+    #
     # @param filter_id [String] The ID of the retention filter.
     # @param opts [Hash] the optional parameters
     # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
@@ -360,6 +364,8 @@ def update_apm_retention_filter(filter_id, body, opts = {})
     #
     # Update a retention filter from your organization.
     #
+    # Default filters (filters with types spans-errors-sampling-processor and spans-appsec-sampling-processor) cannot be renamed or removed.
+    #
     # @param filter_id [String] The ID of the retention filter.
     # @param body [RetentionFilterUpdateRequest] The updated definition of the retention filter.
     # @param opts [Hash] the optional parameters

lib/datadog_api_client/v2/api/apm_retention_filters_api.rb

@@ -0,0 +1,183 @@
+=begin
+#Datadog API V2 Collection
+
+#Collection of all Datadog Public endpoints.
+
+The version of the OpenAPI document: 1.0
+Contact: [email protected]
+Generated by: https://github.com/DataDog/datadog-api-client-ruby/tree/master/.generator
+
+ Unless explicitly stated otherwise all files in this repository are licensed under the Apache-2.0 License.
+ This product includes software developed at Datadog (https://www.datadoghq.com/).
+ Copyright 2020-Present Datadog, Inc.
+
+=end
+
+require 'date'
+require 'time'
+
+module DatadogAPIClient::V2
+  # The object describing the configuration of the retention filter to create/update.
+  class RetentionFilterUpdateAttributes
+    include BaseGenericModel
+
+    # Enable/Disable the retention filter.
+    attr_reader :enabled
+
+    # The spans filter. Spans matching this filter will be indexed and stored.
+    attr_reader :filter
+
+    # The type of retention filter.
+    attr_reader :filter_type
+
+    # The name of the retention filter.
+    attr_reader :name
+
+    # Sample rate to apply to spans going through this retention filter,
+    # a value of 1.0 keeps all spans matching the query.
+    attr_reader :rate
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    # @!visibility private
+    def self.attribute_map
+      {
+        :'enabled' => :'enabled',
+        :'filter' => :'filter',
+        :'filter_type' => :'filter_type',
+        :'name' => :'name',
+        :'rate' => :'rate'
+      }
+    end
+
+    # Attribute type mapping.
+    # @!visibility private
+    def self.openapi_types
+      {
+        :'enabled' => :'Boolean',
+        :'filter' => :'SpansFilterCreate',
+        :'filter_type' => :'RetentionFilterAllType',
+        :'name' => :'String',
+        :'rate' => :'Float'
+      }
+    end
+
+    # Initializes the object
+    # @param attributes [Hash] Model attributes in the form of hash
+    # @!visibility private
+    def initialize(attributes = {})
+      if (!attributes.is_a?(Hash))
+        fail ArgumentError, "The input argument (attributes) must be a hash in `DatadogAPIClient::V2::RetentionFilterUpdateAttributes` initialize method"
+      end
+
+      # check to see if the attribute exists and convert string to symbol for hash key
+      attributes = attributes.each_with_object({}) { |(k, v), h|
+        if (!self.class.attribute_map.key?(k.to_sym))
+          fail ArgumentError, "`#{k}` is not a valid attribute in `DatadogAPIClient::V2::RetentionFilterUpdateAttributes`. Please check the name to make sure it's valid. List of attributes: " + self.class.attribute_map.keys.inspect
+        end
+        h[k.to_sym] = v
+      }
+
+      if attributes.key?(:'enabled')
+        self.enabled = attributes[:'enabled']
+      end
+
+      if attributes.key?(:'filter')
+        self.filter = attributes[:'filter']
+      end
+
+      if attributes.key?(:'filter_type')
+        self.filter_type = attributes[:'filter_type']
+      end
+
+      if attributes.key?(:'name')
+        self.name = attributes[:'name']
+      end
+
+      if attributes.key?(:'rate')
+        self.rate = attributes[:'rate']
+      end
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    # @!visibility private
+    def valid?
+      return false if @enabled.nil?
+      return false if @filter.nil?
+      return false if @filter_type.nil?
+      return false if @name.nil?
+      return false if @rate.nil?
+      true
+    end
+
+    # Custom attribute writer method with validation
+    # @param enabled [Object] Object to be assigned
+    # @!visibility private
+    def enabled=(enabled)
+      if enabled.nil?
+        fail ArgumentError, 'invalid value for "enabled", enabled cannot be nil.'
+      end
+      @enabled = enabled
+    end
+
+    # Custom attribute writer method with validation
+    # @param filter [Object] Object to be assigned
+    # @!visibility private
+    def filter=(filter)
+      if filter.nil?
+        fail ArgumentError, 'invalid value for "filter", filter cannot be nil.'
+      end
+      @filter = filter
+    end
+
+    # Custom attribute writer method with validation
+    # @param filter_type [Object] Object to be assigned
+    # @!visibility private
+    def filter_type=(filter_type)
+      if filter_type.nil?
+        fail ArgumentError, 'invalid value for "filter_type", filter_type cannot be nil.'
+      end
+      @filter_type = filter_type
+    end
+
+    # Custom attribute writer method with validation
+    # @param name [Object] Object to be assigned
+    # @!visibility private
+    def name=(name)
+      if name.nil?
+        fail ArgumentError, 'invalid value for "name", name cannot be nil.'
+      end
+      @name = name
+    end
+
+    # Custom attribute writer method with validation
+    # @param rate [Object] Object to be assigned
+    # @!visibility private
+    def rate=(rate)
+      if rate.nil?
+        fail ArgumentError, 'invalid value for "rate", rate cannot be nil.'
+      end
+      @rate = rate
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param o [Object] Object to be compared
+    # @!visibility private
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          enabled == o.enabled &&
+          filter == o.filter &&
+          filter_type == o.filter_type &&
+          name == o.name &&
+          rate == o.rate
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Integer] Hash code
+    # @!visibility private
+    def hash
+      [enabled, filter, filter_type, name, rate].hash
+    end
+  end
+end

lib/datadog_api_client/v2/models/retention_filter_update_attributes.rb

@@ -44,7 +44,7 @@ def self.attribute_map
     # @!visibility private
     def self.openapi_types
       {
-        :'attributes' => :'RetentionFilterCreateAttributes',
+        :'attributes' => :'RetentionFilterUpdateAttributes',
         :'id' => :'String',
         :'type' => :'ApmRetentionFilterType'
       }