Add RUM settings schema to synthetics tests (#1001)

* Regenerate client from commit da8834e1 of spec repo

* pre-commit fixes

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>
Co-authored-by: Thomas Hervé <[email protected]>

Author: 3 people

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-05-19 13:45:57.312769",
-            "spec_repo_commit": "dc18f74b"
+            "regenerated": "2022-05-19 19:13:20.804693",
+            "spec_repo_commit": "da8834e1"
         },
         "v2": {
             "apigentools_version": "1.6.2",
-            "regenerated": "2022-05-19 13:45:57.324742",
-            "spec_repo_commit": "dc18f74b"
+            "regenerated": "2022-05-19 19:13:20.815894",
+            "spec_repo_commit": "da8834e1"
         }
     }
 }

.generator/schemas/v1/openapi.yaml

@@ -10872,6 +10872,50 @@ components:
           format: int64
           type: integer
       type: object
+    SyntheticsBrowserTestRumSettings:
+      description: 'The RUM data collection settings for the Synthetic browser test.
+
+        **Note:** There are 3 ways to format RUM settings:
+
+
+        `{ isEnabled: false }`
+
+        RUM data is not collected.
+
+
+        `{ isEnabled: true }`
+
+        RUM data is collected from the Synthetic test''s default application.
+
+
+        `{ isEnabled: true, applicationId: "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+        clientTokenId: 12345 }`
+
+        RUM data is collected using the specified application.'
+      example:
+        applicationId: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+        clientTokenId: 12345
+        isEnabled: true
+      properties:
+        applicationId:
+          description: RUM application ID used to collect RUM data for the browser
+            test.
+          example: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx
+          type: string
+        clientTokenId:
+          description: RUM application API key ID used to collect RUM data for the
+            browser test.
+          example: 12345
+          format: int64
+          type: integer
+          x-secret: true
+        isEnabled:
+          description: Determines whether RUM data is collected during test runs.
+          example: true
+          type: boolean
+      required:
+      - isEnabled
+      type: object
     SyntheticsBrowserTestType:
       default: browser
       description: Type of the Synthetic test, `browser`.
@@ -11967,6 +12011,8 @@ components:
           $ref: '#/components/schemas/SyntheticsRestrictedRoles'
         retry:
           $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
+        rumSettings:
+          $ref: '#/components/schemas/SyntheticsBrowserTestRumSettings'
         tick_every:
           description: The frequency at which to run the Synthetic test (in seconds).
           format: int64

docs/datadog_api_client.v1.model.rst

@@ -3689,6 +3689,14 @@ synthetics\_browser\_test\_result\_short\_result
    :undoc-members:
    :show-inheritance:
 
+synthetics\_browser\_test\_rum\_settings
+----------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_browser_test_rum_settings
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 synthetics\_browser\_test\_type
 -------------------------------
 

examples/v1/synthetics/CreateSyntheticsAPITest.py

@@ -11,6 +11,7 @@
 from datadog_api_client.v1.model.synthetics_assertion_operator import SyntheticsAssertionOperator
 from datadog_api_client.v1.model.synthetics_assertion_target import SyntheticsAssertionTarget
 from datadog_api_client.v1.model.synthetics_assertion_type import SyntheticsAssertionType
+from datadog_api_client.v1.model.synthetics_browser_test_rum_settings import SyntheticsBrowserTestRumSettings
 from datadog_api_client.v1.model.synthetics_device_id import SyntheticsDeviceID
 from datadog_api_client.v1.model.synthetics_restricted_roles import SyntheticsRestrictedRoles
 from datadog_api_client.v1.model.synthetics_test_details_sub_type import SyntheticsTestDetailsSubType
@@ -50,6 +51,11 @@
             ]
         ),
         retry=SyntheticsTestOptionsRetry(),
+        rum_settings=SyntheticsBrowserTestRumSettings(
+            application_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+            client_token_id=12345,
+            is_enabled=True,
+        ),
     ),
     status=SyntheticsTestPauseStatus("live"),
     subtype=SyntheticsTestDetailsSubType("http"),

examples/v1/synthetics/CreateSyntheticsBrowserTest_2932742688.py

@@ -0,0 +1,85 @@
+"""
+Create a browser test returns "OK - Returns saved rumSettings." response
+"""
+
+from datadog_api_client import ApiClient, Configuration
+from datadog_api_client.v1.api.synthetics_api import SyntheticsApi
+from datadog_api_client.v1.model.http_method import HTTPMethod
+from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
+from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
+from datadog_api_client.v1.model.synthetics_browser_test_rum_settings import SyntheticsBrowserTestRumSettings
+from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
+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_device_id import SyntheticsDeviceID
+from datadog_api_client.v1.model.synthetics_step import SyntheticsStep
+from datadog_api_client.v1.model.synthetics_step_type import SyntheticsStepType
+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
+
+body = SyntheticsBrowserTest(
+    config=SyntheticsBrowserTestConfig(
+        assertions=[],
+        config_variables=[
+            SyntheticsConfigVariable(
+                example="content-type",
+                name="PROPERTY",
+                pattern="content-type",
+                type=SyntheticsConfigVariableType("text"),
+            ),
+        ],
+        request=SyntheticsTestRequest(
+            method=HTTPMethod("GET"),
+            url="https://datadoghq.com",
+        ),
+        set_cookie="name:test",
+    ),
+    locations=[
+        "aws:us-east-2",
+    ],
+    message="Test message",
+    name="Example-Create_a_browser_test_returns_OK_Returns_saved_rumSettings_response",
+    options=SyntheticsTestOptions(
+        accept_self_signed=False,
+        allow_insecure=True,
+        device_ids=[
+            SyntheticsDeviceID("tablet"),
+        ],
+        disable_cors=True,
+        follow_redirects=True,
+        min_failure_duration=10,
+        min_location_failed=1,
+        no_screenshot=True,
+        retry=SyntheticsTestOptionsRetry(
+            count=3,
+            interval=10.0,
+        ),
+        rum_settings=SyntheticsBrowserTestRumSettings(
+            is_enabled=True,
+            application_id="mockApplicationId",
+            client_token_id=123456,
+        ),
+        tick_every=300,
+    ),
+    tags=[
+        "testing:browser",
+    ],
+    type=SyntheticsBrowserTestType("browser"),
+    steps=[
+        SyntheticsStep(
+            allow_failure=False,
+            is_critical=True,
+            name="Refresh page",
+            params=dict(),
+            type=SyntheticsStepType("refresh"),
+        ),
+    ],
+)
+
+configuration = Configuration()
+with ApiClient(configuration) as api_client:
+    api_instance = SyntheticsApi(api_client)
+    response = api_instance.create_synthetics_browser_test(body=body)
+
+    print(response)

examples/v1/synthetics/UpdateBrowserTest.py

@@ -9,6 +9,7 @@
 from datadog_api_client.v1.model.synthetics_basic_auth_web_type import SyntheticsBasicAuthWebType
 from datadog_api_client.v1.model.synthetics_browser_test import SyntheticsBrowserTest
 from datadog_api_client.v1.model.synthetics_browser_test_config import SyntheticsBrowserTestConfig
+from datadog_api_client.v1.model.synthetics_browser_test_rum_settings import SyntheticsBrowserTestRumSettings
 from datadog_api_client.v1.model.synthetics_browser_test_type import SyntheticsBrowserTestType
 from datadog_api_client.v1.model.synthetics_browser_variable import SyntheticsBrowserVariable
 from datadog_api_client.v1.model.synthetics_browser_variable_type import SyntheticsBrowserVariableType
@@ -75,6 +76,11 @@
             ]
         ),
         retry=SyntheticsTestOptionsRetry(),
+        rum_settings=SyntheticsBrowserTestRumSettings(
+            application_id="xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
+            client_token_id=12345,
+            is_enabled=True,
+        ),
     ),
     status=SyntheticsTestPauseStatus("live"),
     steps=[

src/datadog_api_client/v1/model/synthetics_browser_test_rum_settings.py

@@ -0,0 +1 @@
+2022-05-18T13:08:12.878Z