Update retention filters public API (#1941)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
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:53.239946",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:31.200778",
+            "spec_repo_commit": "8ffb168c"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-04-10 19:44:53.257718",
-            "spec_repo_commit": "3fb610b5"
+            "regenerated": "2024-04-11 15:35:31.217642",
+            "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'

docs/datadog_api_client.v2.model.rst

@@ -6952,6 +6952,13 @@ retention\_filter\_type
    :members:
    :show-inheritance:
 
+retention\_filter\_update\_attributes
+-------------------------------------
+
+.. automodule:: datadog_api_client.v2.model.retention_filter_update_attributes
+   :members:
+   :show-inheritance:
+
 retention\_filter\_update\_data
 -------------------------------
 

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

@@ -6,8 +6,8 @@
 from datadog_api_client import ApiClient, Configuration
 from datadog_api_client.v2.api.apm_retention_filters_api import APMRetentionFiltersApi
 from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
-from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
-from datadog_api_client.v2.model.retention_filter_type import RetentionFilterType
+from datadog_api_client.v2.model.retention_filter_all_type import RetentionFilterAllType
+from datadog_api_client.v2.model.retention_filter_update_attributes import RetentionFilterUpdateAttributes
 from datadog_api_client.v2.model.retention_filter_update_data import RetentionFilterUpdateData
 from datadog_api_client.v2.model.retention_filter_update_request import RetentionFilterUpdateRequest
 from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
@@ -17,14 +17,14 @@
 
 body = RetentionFilterUpdateRequest(
     data=RetentionFilterUpdateData(
-        attributes=RetentionFilterCreateAttributes(
+        attributes=RetentionFilterUpdateAttributes(
             name="test",
             rate=0.9,
             filter=SpansFilterCreate(
                 query="@_top_level:1 test:service-demo",
             ),
             enabled=True,
-            filter_type=RetentionFilterType.SPANS_SAMPLING_PROCESSOR,
+            filter_type=RetentionFilterAllType.SPANS_SAMPLING_PROCESSOR,
         ),
         id="test-id",
         type=ApmRetentionFilterType.apm_retention_filter,

src/datadog_api_client/v2/api/apm_retention_filters_api.py

@@ -161,6 +161,8 @@ def create_apm_retention_filter(
         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: The definition of the new retention filter.
         :type body: RetentionFilterCreateRequest
         :rtype: RetentionFilterResponse
@@ -178,6 +180,8 @@ def delete_apm_retention_filter(
 
         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: The ID of the retention filter.
         :type filter_id: str
         :rtype: None
@@ -242,6 +246,8 @@ def update_apm_retention_filter(
 
         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: The ID of the retention filter.
         :type filter_id: str
         :param body: The updated definition of the retention filter.

src/datadog_api_client/v2/model/retention_filter_update_attributes.py

@@ -0,0 +1,75 @@
+# 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 2019-Present Datadog, Inc.
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+from datadog_api_client.model_utils import (
+    ModelNormal,
+    cached_property,
+)
+
+
+if TYPE_CHECKING:
+    from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
+    from datadog_api_client.v2.model.retention_filter_all_type import RetentionFilterAllType
+
+
+class RetentionFilterUpdateAttributes(ModelNormal):
+    @cached_property
+    def openapi_types(_):
+        from datadog_api_client.v2.model.spans_filter_create import SpansFilterCreate
+        from datadog_api_client.v2.model.retention_filter_all_type import RetentionFilterAllType
+
+        return {
+            "enabled": (bool,),
+            "filter": (SpansFilterCreate,),
+            "filter_type": (RetentionFilterAllType,),
+            "name": (str,),
+            "rate": (float,),
+        }
+
+    attribute_map = {
+        "enabled": "enabled",
+        "filter": "filter",
+        "filter_type": "filter_type",
+        "name": "name",
+        "rate": "rate",
+    }
+
+    def __init__(
+        self_,
+        enabled: bool,
+        filter: SpansFilterCreate,
+        filter_type: RetentionFilterAllType,
+        name: str,
+        rate: float,
+        **kwargs,
+    ):
+        """
+        The object describing the configuration of the retention filter to create/update.
+
+        :param enabled: Enable/Disable the retention filter.
+        :type enabled: bool
+
+        :param filter: The spans filter. Spans matching this filter will be indexed and stored.
+        :type filter: SpansFilterCreate
+
+        :param filter_type: The type of retention filter.
+        :type filter_type: RetentionFilterAllType
+
+        :param name: The name of the retention filter.
+        :type name: str
+
+        :param rate: Sample rate to apply to spans going through this retention filter,
+            a value of 1.0 keeps all spans matching the query.
+        :type rate: float
+        """
+        super().__init__(kwargs)
+
+        self_.enabled = enabled
+        self_.filter = filter
+        self_.filter_type = filter_type
+        self_.name = name
+        self_.rate = rate

src/datadog_api_client/v2/model/retention_filter_update_data.py

@@ -12,18 +12,18 @@
 
 
 if TYPE_CHECKING:
-    from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
+    from datadog_api_client.v2.model.retention_filter_update_attributes import RetentionFilterUpdateAttributes
     from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
 
 
 class RetentionFilterUpdateData(ModelNormal):
     @cached_property
     def openapi_types(_):
-        from datadog_api_client.v2.model.retention_filter_create_attributes import RetentionFilterCreateAttributes
+        from datadog_api_client.v2.model.retention_filter_update_attributes import RetentionFilterUpdateAttributes
         from datadog_api_client.v2.model.apm_retention_filter_type import ApmRetentionFilterType
 
         return {
-            "attributes": (RetentionFilterCreateAttributes,),
+            "attributes": (RetentionFilterUpdateAttributes,),
             "id": (str,),
             "type": (ApmRetentionFilterType,),
         }
@@ -34,12 +34,12 @@ def openapi_types(_):
         "type": "type",
     }
 
-    def __init__(self_, attributes: RetentionFilterCreateAttributes, id: str, type: ApmRetentionFilterType, **kwargs):
+    def __init__(self_, attributes: RetentionFilterUpdateAttributes, id: str, type: ApmRetentionFilterType, **kwargs):
         """
         The body of the retention filter to be updated.
 
         :param attributes: The object describing the configuration of the retention filter to create/update.
-        :type attributes: RetentionFilterCreateAttributes
+        :type attributes: RetentionFilterUpdateAttributes
 
         :param id: The ID of the retention filter.
         :type id: str

src/datadog_api_client/v2/models/__init__.py

@@ -1222,6 +1222,7 @@
 from datadog_api_client.v2.model.retention_filter_create_request import RetentionFilterCreateRequest
 from datadog_api_client.v2.model.retention_filter_response import RetentionFilterResponse
 from datadog_api_client.v2.model.retention_filter_type import RetentionFilterType
+from datadog_api_client.v2.model.retention_filter_update_attributes import RetentionFilterUpdateAttributes
 from datadog_api_client.v2.model.retention_filter_update_data import RetentionFilterUpdateData
 from datadog_api_client.v2.model.retention_filter_update_request import RetentionFilterUpdateRequest
 from datadog_api_client.v2.model.retention_filter_without_attributes import RetentionFilterWithoutAttributes
@@ -2832,6 +2833,7 @@
     "RetentionFilterCreateRequest",
     "RetentionFilterResponse",
     "RetentionFilterType",
+    "RetentionFilterUpdateAttributes",
     "RetentionFilterUpdateData",
     "RetentionFilterUpdateRequest",
     "RetentionFilterWithoutAttributes",

tests/v2/cassettes/test_scenarios/test_create_a_default_retention_filter_returns_bad_request_response.frozen

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

tests/v2/cassettes/test_scenarios/test_create_a_default_retention_filter_returns_bad_request_response.yaml

@@ -0,0 +1,22 @@
+interactions:
+- request:
+    body: '{"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},"type":"apm_retention_filter"}}'
+    headers:
+      accept:
+      - application/json
+      content-type:
+      - application/json
+    method: POST
+    uri: https://api.datadoghq.com/api/v2/apm/config/retention-filters
+  response:
+    body:
+      string: '{"errors":["Field ''filter_type'' is invalid, expected value is ''spans-sampling-processor''"]}'
+    headers:
+      content-type:
+      - application/json
+    status:
+      code: 400
+      message: Bad Request
+version: 1