Regenerate client from commit 1d2b67d9 of spec repo (#1100)

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.4",
-            "regenerated": "2022-08-30 12:29:08.851250",
-            "spec_repo_commit": "47f45603"
+            "regenerated": "2022-08-30 13:34:34.295369",
+            "spec_repo_commit": "1d2b67d9"
         },
         "v2": {
             "apigentools_version": "1.6.4",
-            "regenerated": "2022-08-30 12:29:08.863371",
-            "spec_repo_commit": "47f45603"
+            "regenerated": "2022-08-30 13:34:34.310816",
+            "spec_repo_commit": "1d2b67d9"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -11898,25 +11898,31 @@ components:
             the value.
           example: content-type
           type: string
+        localVariableName:
+          description: When type is `local_variable`, name of the local variable to
+            use to extract the value.
+          example: LOCAL_VARIABLE
+          type: string
         parser:
           $ref: '#/components/schemas/SyntheticsVariableParser'
         type:
           $ref: '#/components/schemas/SyntheticsGlobalVariableParseTestOptionsType'
       required:
       - type
-      - parser
       type: object
     SyntheticsGlobalVariableParseTestOptionsType:
       description: Property of the Synthetics Test Response to use for a Synthetics
         global variable.
       enum:
       - http_body
       - http_header
+      - local_variable
       example: http_body
       type: string
       x-enum-varnames:
       - HTTP_BODY
       - HTTP_HEADER
+      - LOCAL_VARIABLE
     SyntheticsGlobalVariableParserType:
       description: Type of parser for a Synthetics global variable from a synthetics
         test.

examples/v1/synthetics/CreateGlobalVariable.py

@@ -29,6 +29,7 @@
     name="MY_VARIABLE",
     parse_test_options=SyntheticsGlobalVariableParseTestOptions(
         field="content-type",
+        local_variable_name="LOCAL_VARIABLE",
         parser=SyntheticsVariableParser(
             type=SyntheticsGlobalVariableParserType("regex"),
             value=".*",

examples/v1/synthetics/CreateGlobalVariable_1068962881.py

@@ -0,0 +1,40 @@
+"""
+Create a global variable from test returns "OK" response
+"""
+
+from os import environ
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
+from datadog_api_client.v1.model.synthetics_global_variable import SyntheticsGlobalVariable
+from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options import (
+    SyntheticsGlobalVariableParseTestOptions,
+)
+from datadog_api_client.v1.model.synthetics_global_variable_parse_test_options_type import (
+    SyntheticsGlobalVariableParseTestOptionsType,
+)
+from datadog_api_client.v1.model.synthetics_global_variable_value import SyntheticsGlobalVariableValue
+
+# there is a valid "synthetics_api_test_multi_step" in the system
+SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID = environ["SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID"]
+
+body = SyntheticsGlobalVariable(
+    description="",
+    name="GLOBAL_VARIABLE_PAYLOAD",
+    tags=[],
+    value=SyntheticsGlobalVariableValue(
+        secure=False,
+        value="",
+    ),
+    parse_test_public_id=SYNTHETICS_API_TEST_MULTI_STEP_PUBLIC_ID,
+    parse_test_options=SyntheticsGlobalVariableParseTestOptions(
+        type=SyntheticsGlobalVariableParseTestOptionsType("local_variable"),
+        local_variable_name="EXTRACTED_VALUE",
+    ),
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.create_global_variable(body=body)
+
+    print(response)

examples/v1/synthetics/CreateSyntheticsAPITest_1279271422.py

@@ -15,10 +15,16 @@
 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_parsing_options import SyntheticsParsingOptions
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
 from datadog_api_client.v1.model.synthetics_test_options import SyntheticsTestOptions
 from datadog_api_client.v1.model.synthetics_test_options_retry import SyntheticsTestOptionsRetry
 from datadog_api_client.v1.model.synthetics_test_request import SyntheticsTestRequest
+from datadog_api_client.v1.model.synthetics_variable_parser import SyntheticsVariableParser
 
 body = SyntheticsAPITest(
     config=SyntheticsAPITestConfig(
@@ -40,6 +46,16 @@
                         target=200,
                     ),
                 ],
+                extracted_values=[
+                    SyntheticsParsingOptions(
+                        field="server",
+                        name="EXTRACTED_VALUE",
+                        parser=SyntheticsVariableParser(
+                            type=SyntheticsGlobalVariableParserType("raw"),
+                        ),
+                        type=SyntheticsGlobalVariableParseTestOptionsType("http_header"),
+                    ),
+                ],
                 is_critical=True,
                 name="request is sent",
                 request=SyntheticsTestRequest(

examples/v1/synthetics/EditGlobalVariable.py

@@ -29,6 +29,7 @@
     name="MY_VARIABLE",
     parse_test_options=SyntheticsGlobalVariableParseTestOptions(
         field="content-type",
+        local_variable_name="LOCAL_VARIABLE",
         parser=SyntheticsVariableParser(
             type=SyntheticsGlobalVariableParserType("regex"),
             value=".*",

src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options.py

@@ -19,25 +19,30 @@ def openapi_types(_):
 
         return {
             "field": (str,),
+            "local_variable_name": (str,),
             "parser": (SyntheticsVariableParser,),
             "type": (SyntheticsGlobalVariableParseTestOptionsType,),
         }
 
     attribute_map = {
         "field": "field",
+        "local_variable_name": "localVariableName",
         "parser": "parser",
         "type": "type",
     }
 
-    def __init__(self, parser, type, *args, **kwargs):
+    def __init__(self, type, *args, **kwargs):
         """
         Parser options to use for retrieving a Synthetics global variable from a Synthetics Test. Used in conjunction with ``parse_test_public_id``.
 
         :param field: When type is ``http_header`` , name of the header to use to extract the value.
         :type field: str, optional
 
+        :param local_variable_name: When type is ``local_variable`` , name of the local variable to use to extract the value.
+        :type local_variable_name: str, optional
+
         :param parser: Details of the parser to use for the global variable.
-        :type parser: SyntheticsVariableParser
+        :type parser: SyntheticsVariableParser, optional
 
         :param type: Property of the Synthetics Test Response to use for a Synthetics global variable.
         :type type: SyntheticsGlobalVariableParseTestOptionsType
@@ -46,17 +51,15 @@ def __init__(self, parser, type, *args, **kwargs):
 
         self._check_pos_args(args)
 
-        self.parser = parser
         self.type = type
 
     @classmethod
-    def _from_openapi_data(cls, parser, type, *args, **kwargs):
+    def _from_openapi_data(cls, type, *args, **kwargs):
         """Helper creating a new instance from a response."""
 
         self = super(SyntheticsGlobalVariableParseTestOptions, cls)._from_openapi_data(kwargs)
 
         self._check_pos_args(args)
 
-        self.parser = parser
         self.type = type
         return self

src/datadog_api_client/v1/model/synthetics_global_variable_parse_test_options_type.py

@@ -13,14 +13,15 @@ class SyntheticsGlobalVariableParseTestOptionsType(ModelSimple):
     """
     Property of the Synthetics Test Response to use for a Synthetics global variable.
 
-    :param value: Must be one of ["http_body", "http_header"].
+    :param value: Must be one of ["http_body", "http_header", "local_variable"].
     :type value: str
     """
 
     allowed_values = {
         "value": {
             "HTTP_BODY": "http_body",
             "HTTP_HEADER": "http_header",
+            "LOCAL_VARIABLE": "local_variable",
         },
     }
 

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_saved_rumsettings_response.frozen

@@ -1 +1 @@
-2022-08-18T09:19:30.220Z
+2022-08-30T12:58:36.103Z

tests/v1/cassettes/test_scenarios/test_create_a_browser_test_returns_ok_returns_saved_rumsettings_response.yaml

@@ -1,7 +1,7 @@
 interactions:
 - request:
     body: '{"config":{"assertions":[],"configVariables":[{"example":"content-type","name":"PROPERTY","pattern":"content-type","type":"text"}],"request":{"certificateDomains":["https://datadoghq.com"],"method":"GET","url":"https://datadoghq.com"},"setCookie":"name:test"},"locations":["aws:us-east-2"],"message":"Test
-      message","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1660814370","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":3,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"steps":[{"allowFailure":false,"isCritical":true,"name":"Refresh
+      message","name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1661864316","options":{"accept_self_signed":false,"allow_insecure":true,"ci":{"executionRule":"skipped"},"device_ids":["tablet"],"disableCors":true,"disableCsp":true,"follow_redirects":true,"ignoreServerCertificateError":true,"initialNavigationTimeout":200,"min_failure_duration":10,"min_location_failed":1,"noScreenshot":true,"retry":{"count":3,"interval":10},"rumSettings":{"applicationId":"mockApplicationId","clientTokenId":12345,"isEnabled":true},"tick_every":300},"steps":[{"allowFailure":false,"isCritical":true,"name":"Refresh
       page","params":{},"type":"refresh"}],"tags":["testing:browser"],"type":"browser"}'
     headers:
       accept:
@@ -12,8 +12,8 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/browser
   response:
     body:
-      string: '{"status":"paused","public_id":"3ry-tnf-fqu","tags":["testing:browser"],"org_id":321813,"locations":["aws:us-east-2"],"message":"Test
-        message","deleted_at":null,"name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1660814370","monitor_id":80432986,"type":"browser","created_at":"2022-08-18T09:19:30.959520+00:00","modified_at":"2022-08-18T09:19:30.959520+00:00","steps":[{"name":"Refresh
+      string: '{"status":"paused","public_id":"jsu-a6z-5fw","tags":["testing:browser"],"org_id":321813,"locations":["aws:us-east-2"],"message":"Test
+        message","deleted_at":null,"name":"Test-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response-1661864316","monitor_id":81568552,"type":"browser","created_at":"2022-08-30T12:58:36.698302+00:00","modified_at":"2022-08-30T12:58:36.698302+00:00","steps":[{"name":"Refresh
         page","allowFailure":false,"params":{},"isCritical":true,"type":"refresh"}],"config":{"setCookie":"name:test","request":{"url":"https://datadoghq.com","certificateDomains":["https://datadoghq.com"],"method":"GET"},"assertions":[],"configVariables":[{"pattern":"content-type","type":"text","example":"content-type","name":"PROPERTY"}]},"options":{"disableCsp":true,"accept_self_signed":false,"retry":{"count":3,"interval":10},"min_location_failed":1,"allow_insecure":true,"follow_redirects":true,"min_failure_duration":10,"ci":{"executionRule":"skipped"},"noScreenshot":true,"rumSettings":{"isEnabled":true,"applicationId":"mockApplicationId","clientTokenId":12345},"initialNavigationTimeout":200,"disableCors":true,"device_ids":["tablet"],"tick_every":300,"ignoreServerCertificateError":true}}'
     headers:
       content-type:
@@ -22,7 +22,7 @@ interactions:
       code: 200
       message: OK
 - request:
-    body: '{"public_ids":["3ry-tnf-fqu"]}'
+    body: '{"public_ids":["jsu-a6z-5fw"]}'
     headers:
       accept:
       - application/json
@@ -32,7 +32,7 @@ interactions:
     uri: https://api.datadoghq.com/api/v1/synthetics/tests/delete
   response:
     body:
-      string: '{"deleted_tests":[{"deleted_at":"2022-08-18T09:19:36.462930+00:00","public_id":"3ry-tnf-fqu"}]}'
+      string: '{"deleted_tests":[{"deleted_at":"2022-08-30T12:58:42.293815+00:00","public_id":"jsu-a6z-5fw"}]}'
     headers:
       content-type:
       - application/json