Fix VFTs and extracted local variables enum types (#2078)

api-clients-generation-pipeline[bot] · ci.datadog-api-spec · web-flow · commit f3d71866f897 · 2024-09-03T14:27:50.000Z
Co-authored-by: ci.datadog-api-spec &lt;packages@datadoghq.com&gt;
Co-authored-by: api-clients-generation-pipeline[bot] &lt;54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com&gt;
diff --git a/.apigentools-info b/.apigentools-info
@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-29 20:02:03.124770",
-            "spec_repo_commit": "518ca9df"
+            "regenerated": "2024-09-03 13:58:40.388311",
+            "spec_repo_commit": "ff772101"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2024-08-29 20:02:03.141872",
-            "spec_repo_commit": "518ca9df"
+            "regenerated": "2024-09-03 13:58:40.405077",
+            "spec_repo_commit": "ff772101"
         }
     }
 }
diff --git a/.generator/schemas/v1/openapi.yaml b/.generator/schemas/v1/openapi.yaml
@@ -15267,17 +15267,18 @@ components:
       - type
       type: object
     SyntheticsGlobalVariableParseTestOptionsType:
-      description: Property of the Synthetic Test Response to use for a Synthetic
-        global variable.
+      description: Type of value to extract from a test for a Synthetic global variable.
       enum:
       - http_body
       - http_header
+      - http_status_code
       - local_variable
       example: http_body
       type: string
       x-enum-varnames:
       - HTTP_BODY
       - HTTP_HEADER
+      - HTTP_STATUS_CODE
       - LOCAL_VARIABLE
     SyntheticsGlobalVariableParserType:
       description: Type of parser for a Synthetic global variable from a synthetics
@@ -15396,6 +15397,23 @@ components:
             $ref: '#/components/schemas/SyntheticsTestDetails'
           type: array
       type: object
+    SyntheticsLocalVariableParsingOptionsType:
+      description: Property of the Synthetic Test Response to extract into a local
+        variable.
+      enum:
+      - grpc_message
+      - grpc_metadata
+      - http_body
+      - http_header
+      - http_status_code
+      example: http_body
+      type: string
+      x-enum-varnames:
+      - GRPC_MESSAGE
+      - GRPC_METADATA
+      - HTTP_BODY
+      - HTTP_HEADER
+      - HTTP_STATUS_CODE
     SyntheticsLocation:
       description: 'Synthetic location that can be used when creating or editing a
 
@@ -15422,8 +15440,8 @@ components:
       example: {}
       properties:
         field:
-          description: When type is `http_header`, name of the header to use to extract
-            the value.
+          description: When type is `http_header` or `grpc_metadata`, name of the
+            header or metadatum to extract.
           example: content-type
           type: string
         name:
@@ -15435,7 +15453,7 @@ components:
           description: Determines whether or not the extracted value will be obfuscated.
           type: boolean
         type:
-          $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
+          $ref: '#/components/schemas/SyntheticsLocalVariableParsingOptionsType'
       type: object
     SyntheticsPatchTestBody:
       description: Wrapper around an array of [JSON Patch](https://jsonpatch.com)
@@ -16010,7 +16028,7 @@ components:
       type: object
     SyntheticsTestMetadata:
       additionalProperties:
-        description: A single Metadatum.
+        description: A single metadatum.
         type: string
       description: Metadata to include when performing the gRPC test.
       type: object
diff --git a/docs/datadog_api_client.v1.model.rst b/docs/datadog_api_client.v1.model.rst
@@ -4435,6 +4435,13 @@ datadog\_api\_client.v1.model.synthetics\_list\_tests\_response module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.synthetics\_local\_variable\_parsing\_options\_type module
+----------------------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_local_variable_parsing_options_type
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.synthetics\_location module
 ---------------------------------------------------------
 
diff --git a/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py b/examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py
@@ -16,10 +16,10 @@
 from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
 from datadog_api_client.v1.model.synthetics_config_variable import SyntheticsConfigVariable
 from datadog_api_client.v1.model.synthetics_config_variable_type import SyntheticsConfigVariableType
-from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options_type import (
-    SyntheticsGlobalVariableParseTestOptionsType,
-)
 from datadog_api_client.v1.model.synthetics_global_variable_parser_type import SyntheticsGlobalVariableParserType
+from datadog_api_client.v1.model.synthetics_local_variable_parsing_options_type import (
+    SyntheticsLocalVariableParsingOptionsType,
+)
 from datadog_api_client.v1.model.synthetics_parsing_options import SyntheticsParsingOptions
 from datadog_api_client.v1.model.synthetics_test_call_type import SyntheticsTestCallType
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
@@ -57,7 +57,7 @@
                         parser=SyntheticsVariableParser(
                             type=SyntheticsGlobalVariableParserType.RAW,
                         ),
-                        type=SyntheticsGlobalVariableParseTestOptionsType.HTTP_HEADER,
+                        type=SyntheticsLocalVariableParsingOptionsType.HTTP_HEADER,
                         secure=True,
                     ),
                 ],
diff --git a/src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options.py b/src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options.py
@@ -62,7 +62,7 @@ def __init__(
         :param parser: Details of the parser to use for the global variable.
         :type parser: SyntheticsVariableParser, optional
 
-        :param type: Property of the Synthetic Test Response to use for a Synthetic global variable.
+        :param type: Type of value to extract from a test for a Synthetic global variable.
         :type type: SyntheticsGlobalVariableParseTestOptionsType
         """
         if field is not unset:
diff --git a/src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options_type.py b/src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options_type.py
@@ -14,19 +14,21 @@
 
 class SyntheticsGlobalVariableParseTestOptionsType(ModelSimple):
     """
-    Property of the Synthetic Test Response to use for a Synthetic global variable.
+    Type of value to extract from a test for a Synthetic global variable.
 
-    :param value: Must be one of ["http_body", "http_header", "local_variable"].
+    :param value: Must be one of ["http_body", "http_header", "http_status_code", "local_variable"].
     :type value: str
     """
 
     allowed_values = {
         "http_body",
         "http_header",
+        "http_status_code",
         "local_variable",
     }
     HTTP_BODY: ClassVar["SyntheticsGlobalVariableParseTestOptionsType"]
     HTTP_HEADER: ClassVar["SyntheticsGlobalVariableParseTestOptionsType"]
+    HTTP_STATUS_CODE: ClassVar["SyntheticsGlobalVariableParseTestOptionsType"]
     LOCAL_VARIABLE: ClassVar["SyntheticsGlobalVariableParseTestOptionsType"]
 
     @cached_property
@@ -38,6 +40,9 @@ def openapi_types(_):
 
 SyntheticsGlobalVariableParseTestOptionsType.HTTP_BODY = SyntheticsGlobalVariableParseTestOptionsType("http_body")
 SyntheticsGlobalVariableParseTestOptionsType.HTTP_HEADER = SyntheticsGlobalVariableParseTestOptionsType("http_header")
+SyntheticsGlobalVariableParseTestOptionsType.HTTP_STATUS_CODE = SyntheticsGlobalVariableParseTestOptionsType(
+    "http_status_code"
+)
 SyntheticsGlobalVariableParseTestOptionsType.LOCAL_VARIABLE = SyntheticsGlobalVariableParseTestOptionsType(
     "local_variable"
 )
diff --git a/src/datadog_api_client/v1/model/synthetics_local_variable_parsing_options_type.py b/src/datadog_api_client/v1/model/synthetics_local_variable_parsing_options_type.py
@@ -0,0 +1,49 @@
+# 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 datadog_api_client.model_utils import (
+    ModelSimple,
+    cached_property,
+)
+
+from typing import ClassVar
+
+
+class SyntheticsLocalVariableParsingOptionsType(ModelSimple):
+    """
+    Property of the Synthetic Test Response to extract into a local variable.
+
+    :param value: Must be one of ["grpc_message", "grpc_metadata", "http_body", "http_header", "http_status_code"].
+    :type value: str
+    """
+
+    allowed_values = {
+        "grpc_message",
+        "grpc_metadata",
+        "http_body",
+        "http_header",
+        "http_status_code",
+    }
+    GRPC_MESSAGE: ClassVar["SyntheticsLocalVariableParsingOptionsType"]
+    GRPC_METADATA: ClassVar["SyntheticsLocalVariableParsingOptionsType"]
+    HTTP_BODY: ClassVar["SyntheticsLocalVariableParsingOptionsType"]
+    HTTP_HEADER: ClassVar["SyntheticsLocalVariableParsingOptionsType"]
+    HTTP_STATUS_CODE: ClassVar["SyntheticsLocalVariableParsingOptionsType"]
+
+    @cached_property
+    def openapi_types(_):
+        return {
+            "value": (str,),
+        }
+
+
+SyntheticsLocalVariableParsingOptionsType.GRPC_MESSAGE = SyntheticsLocalVariableParsingOptionsType("grpc_message")
+SyntheticsLocalVariableParsingOptionsType.GRPC_METADATA = SyntheticsLocalVariableParsingOptionsType("grpc_metadata")
+SyntheticsLocalVariableParsingOptionsType.HTTP_BODY = SyntheticsLocalVariableParsingOptionsType("http_body")
+SyntheticsLocalVariableParsingOptionsType.HTTP_HEADER = SyntheticsLocalVariableParsingOptionsType("http_header")
+SyntheticsLocalVariableParsingOptionsType.HTTP_STATUS_CODE = SyntheticsLocalVariableParsingOptionsType(
+    "http_status_code"
+)
diff --git a/src/datadog_api_client/v1/model/synthetics_parsing_options.py b/src/datadog_api_client/v1/model/synthetics_parsing_options.py
@@ -15,25 +15,25 @@
 
 if TYPE_CHECKING:
     from datadog_api_client.v1.model.synthetics_variable_parser import SyntheticsVariableParser
-    from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options_type import (
-        SyntheticsGlobalVariableParseTestOptionsType,
+    from datadog_api_client.v1.model.synthetics_local_variable_parsing_options_type import (
+        SyntheticsLocalVariableParsingOptionsType,
     )
 
 
 class SyntheticsParsingOptions(ModelNormal):
     @cached_property
     def openapi_types(_):
         from datadog_api_client.v1.model.synthetics_variable_parser import SyntheticsVariableParser
-        from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options_type import (
-            SyntheticsGlobalVariableParseTestOptionsType,
+        from datadog_api_client.v1.model.synthetics_local_variable_parsing_options_type import (
+            SyntheticsLocalVariableParsingOptionsType,
         )
 
         return {
             "field": (str,),
             "name": (str,),
             "parser": (SyntheticsVariableParser,),
             "secure": (bool,),
-            "type": (SyntheticsGlobalVariableParseTestOptionsType,),
+            "type": (SyntheticsLocalVariableParsingOptionsType,),
         }
 
     attribute_map = {
@@ -50,13 +50,13 @@ def __init__(
         name: Union[str, UnsetType] = unset,
         parser: Union[SyntheticsVariableParser, UnsetType] = unset,
         secure: Union[bool, UnsetType] = unset,
-        type: Union[SyntheticsGlobalVariableParseTestOptionsType, UnsetType] = unset,
+        type: Union[SyntheticsLocalVariableParsingOptionsType, UnsetType] = unset,
         **kwargs,
     ):
         """
         Parsing options for variables to extract.
 
-        :param field: When type is ``http_header`` , name of the header to use to extract the value.
+        :param field: When type is ``http_header`` or ``grpc_metadata`` , name of the header or metadatum to extract.
         :type field: str, optional
 
         :param name: Name of the variable to extract.
@@ -68,8 +68,8 @@ def __init__(
         :param secure: Determines whether or not the extracted value will be obfuscated.
         :type secure: bool, optional
 
-        :param type: Property of the Synthetic Test Response to use for a Synthetic global variable.
-        :type type: SyntheticsGlobalVariableParseTestOptionsType, optional
+        :param type: Property of the Synthetic Test Response to extract into a local variable.
+        :type type: SyntheticsLocalVariableParsingOptionsType, optional
         """
         if field is not unset:
             kwargs["field"] = field
diff --git a/src/datadog_api_client/v1/models/__init__.py b/src/datadog_api_client/v1/models/__init__.py
@@ -723,6 +723,9 @@
 from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue
 from datadog_api_client.v1.model.synthetics_list_global_variables_response import SyntheticsListGlobalVariablesResponse
 from datadog_api_client.v1.model.synthetics_list_tests_response import SyntheticsListTestsResponse
+from datadog_api_client.v1.model.synthetics_local_variable_parsing_options_type import (
+    SyntheticsLocalVariableParsingOptionsType,
+)
 from datadog_api_client.v1.model.synthetics_location import SyntheticsLocation
 from datadog_api_client.v1.model.synthetics_locations import SyntheticsLocations
 from datadog_api_client.v1.model.synthetics_parsing_options import SyntheticsParsingOptions
@@ -1616,6 +1619,7 @@
     "SyntheticsGlobalVariableValue",
     "SyntheticsListGlobalVariablesResponse",
     "SyntheticsListTestsResponse",
+    "SyntheticsLocalVariableParsingOptionsType",
     "SyntheticsLocation",
     "SyntheticsLocations",
     "SyntheticsParsingOptions",

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": "2024-08-29 20:02:03.124770",`
`8`		`- "spec_repo_commit": "518ca9df"`
	`7`	`+ "regenerated": "2024-09-03 13:58:40.388311",`
	`8`	`+ "spec_repo_commit": "ff772101"`
`9`	`9`	`},`
`10`	`10`	`"v2": {`
`11`	`11`	`"apigentools_version": "1.6.6",`
`12`		`- "regenerated": "2024-08-29 20:02:03.141872",`
`13`		`- "spec_repo_commit": "518ca9df"`
	`12`	`+ "regenerated": "2024-09-03 13:58:40.405077",`
	`13`	`+ "spec_repo_commit": "ff772101"`
`14`	`14`	`}`
`15`	`15`	`}`
`16`	`16`	`}`