Add tags and description to logs pipelines (#2374)

Co-authored-by: ci.datadog-api-spec <[email protected]>

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

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-23 20:46:00.158208",
-            "spec_repo_commit": "2350cf2b"
+            "regenerated": "2025-01-23 21:37:44.264707",
+            "spec_repo_commit": "ff83ed06"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-01-23 20:46:00.172961",
-            "spec_repo_commit": "2350cf2b"
+            "regenerated": "2025-01-23 21:37:44.282504",
+            "spec_repo_commit": "ff83ed06"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -5926,6 +5926,9 @@ components:
 
         Make sure to use an application key created by an admin.'
       properties:
+        description:
+          description: A description of the pipeline.
+          type: string
         filter:
           $ref: '#/components/schemas/LogsFilter'
         id:
@@ -5948,6 +5951,12 @@ components:
           items:
             $ref: '#/components/schemas/LogsProcessor'
           type: array
+        tags:
+          description: A list of tags associated with the pipeline.
+          items:
+            description: A single tag using the format `key:value`.
+            type: string
+          type: array
         type:
           description: Type of pipeline.
           example: pipeline

examples/v1/logs-pipelines/CreateLogsPipeline.py

@@ -27,6 +27,7 @@
             type=LogsGrokParserType.GROK_PARSER,
         ),
     ],
+    tags=[],
 )
 
 configuration = Configuration()

examples/v1/logs-pipelines/UpdateLogsPipeline.py

@@ -27,6 +27,7 @@
             type=LogsGrokParserType.GROK_PARSER,
         ),
     ],
+    tags=[],
 )
 
 configuration = Configuration()

src/datadog_api_client/v1/model/logs_pipeline.py

@@ -41,22 +41,26 @@ def openapi_types(_):
         from datadog_api_client.v1.model.logs_processor import LogsProcessor
 
         return {
+            "description": (str,),
             "filter": (LogsFilter,),
             "id": (str,),
             "is_enabled": (bool,),
             "is_read_only": (bool,),
             "name": (str,),
             "processors": ([LogsProcessor],),
+            "tags": ([str],),
             "type": (str,),
         }
 
     attribute_map = {
+        "description": "description",
         "filter": "filter",
         "id": "id",
         "is_enabled": "is_enabled",
         "is_read_only": "is_read_only",
         "name": "name",
         "processors": "processors",
+        "tags": "tags",
         "type": "type",
     }
     read_only_vars = {
@@ -68,6 +72,7 @@ def openapi_types(_):
     def __init__(
         self_,
         name: str,
+        description: Union[str, UnsetType] = unset,
         filter: Union[LogsFilter, UnsetType] = unset,
         id: Union[str, UnsetType] = unset,
         is_enabled: Union[bool, UnsetType] = unset,
@@ -96,6 +101,7 @@ def __init__(
             ],
             UnsetType,
         ] = unset,
+        tags: Union[List[str], UnsetType] = unset,
         type: Union[str, UnsetType] = unset,
         **kwargs,
     ):
@@ -106,6 +112,9 @@ def __init__(
         **Note** : These endpoints are only available for admin users.
         Make sure to use an application key created by an admin.
 
+        :param description: A description of the pipeline.
+        :type description: str, optional
+
         :param filter: Filter for logs.
         :type filter: LogsFilter, optional
 
@@ -124,9 +133,14 @@ def __init__(
         :param processors: Ordered list of processors in this pipeline.
         :type processors: [LogsProcessor], optional
 
+        :param tags: A list of tags associated with the pipeline.
+        :type tags: [str], optional
+
         :param type: Type of pipeline.
         :type type: str, optional
         """
+        if description is not unset:
+            kwargs["description"] = description
         if filter is not unset:
             kwargs["filter"] = filter
         if id is not unset:
@@ -137,6 +151,8 @@ def __init__(
             kwargs["is_read_only"] = is_read_only
         if processors is not unset:
             kwargs["processors"] = processors
+        if tags is not unset:
+            kwargs["tags"] = tags
         if type is not unset:
             kwargs["type"] = type
         super().__init__(kwargs)

tests/v1/features/logs_pipelines.feature

@@ -26,14 +26,14 @@ Feature: Logs Pipelines
   @generated @skip @team:DataDog/event-platform-experience
   Scenario: Create a pipeline returns "Bad Request" response
     Given new "CreateLogsPipeline" request
-    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}]}
+    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}], "tags": []}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/event-platform-experience
   Scenario: Create a pipeline returns "OK" response
     Given new "CreateLogsPipeline" request
-    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}]}
+    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}], "tags": []}
     When the request is sent
     Then the response status is 200 OK
 
@@ -81,15 +81,15 @@ Feature: Logs Pipelines
   Scenario: Update a pipeline returns "Bad Request" response
     Given new "UpdateLogsPipeline" request
     And request contains "pipeline_id" parameter from "REPLACE.ME"
-    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}]}
+    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}], "tags": []}
     When the request is sent
     Then the response status is 400 Bad Request
 
   @generated @skip @team:DataDog/event-platform-experience
   Scenario: Update a pipeline returns "OK" response
     Given new "UpdateLogsPipeline" request
     And request contains "pipeline_id" parameter from "REPLACE.ME"
-    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}]}
+    And body with value {"filter": {"query": "source:python"}, "name": "", "processors": [{"grok": {"match_rules": "rule_name_1 foo\nrule_name_2 bar\n", "support_rules": "rule_name_1 foo\nrule_name_2 bar\n"}, "is_enabled": false, "samples": [], "source": "message", "type": "grok-parser"}], "tags": []}
     When the request is sent
     Then the response status is 200 OK