Add subtest for synthetics multistep tests (#3197)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>

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

.generator/schemas/v1/openapi.yaml

@@ -14766,6 +14766,61 @@ components:
       oneOf:
       - $ref: '#/components/schemas/SyntheticsAPITestStep'
       - $ref: '#/components/schemas/SyntheticsAPIWaitStep'
+      - $ref: '#/components/schemas/SyntheticsAPISubtestStep'
+    SyntheticsAPISubtestStep:
+      description: The subtest step used in a Synthetics multi-step API test.
+      properties:
+        allowFailure:
+          description: Determines whether or not to continue with test if this step
+            fails.
+          type: boolean
+        alwaysExecute:
+          description: A boolean set to always execute this step even if the previous
+            step failed or was skipped.
+          type: boolean
+        exitIfSucceed:
+          description: Determines whether or not to exit the test if the step succeeds.
+          type: boolean
+        extractedValuesFromScript:
+          description: Generate variables using JavaScript.
+          type: string
+        id:
+          description: ID of the step.
+          example: abc-def-123
+          readOnly: true
+          type: string
+        isCritical:
+          description: 'Determines whether or not to consider the entire test as failed
+            if this step fails.
+
+            Can be used only if `allowFailure` is `true`.'
+          type: boolean
+        name:
+          description: The name of the step.
+          example: Example step name
+          type: string
+        retry:
+          $ref: '#/components/schemas/SyntheticsTestOptionsRetry'
+        subtestPublicId:
+          description: Public ID of the test to be played as part of a `playSubTest`
+            step type.
+          example: ''
+          type: string
+        subtype:
+          $ref: '#/components/schemas/SyntheticsAPISubtestStepSubtype'
+      required:
+      - name
+      - subtype
+      - subtestPublicId
+      type: object
+    SyntheticsAPISubtestStepSubtype:
+      description: The subtype of the Synthetic multi-step API subtest step.
+      enum:
+      - playSubTest
+      example: playSubTest
+      type: string
+      x-enum-varnames:
+      - PLAY_SUB_TEST
     SyntheticsAPITest:
       description: Object containing details about a Synthetic API test.
       properties:

cassettes/v1/Synthetics_2658572017/Create-a-multistep-test-with-subtest-returns-OK-response_3208435401/frozen.json

@@ -0,0 +1 @@
+"2025-12-26T15:22:45.114Z"

cassettes/v1/Synthetics_2658572017/Create-a-multistep-test-with-subtest-returns-OK-response_3208435401/recording.har

@@ -0,0 +1,226 @@
+{
+  "log": {
+    "_recordingName": "Synthetics/Create a multistep test with subtest returns \"OK\" response",
+    "creator": {
+      "comment": "persister:fs",
+      "name": "Polly.JS",
+      "version": "6.0.5"
+    },
+    "entries": [
+      {
+        "_id": "adbf978a00beb492addf278c71d44fa0",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 2257,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 579,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"config\":{\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"target\":\"text/html\",\"type\":\"header\"},{\"operator\":\"lessThan\",\"target\":2000,\"timingsScope\":\"withoutDNS\",\"type\":\"responseTime\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"elementsOperator\":\"atLeastOneElementMatches\",\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONSchema\",\"target\":{\"jsonSchema\":\"{\\\"type\\\": \\\"object\\\", \\\"properties\\\":{\\\"slideshow\\\":{\\\"type\\\":\\\"object\\\"}}}\",\"metaSchema\":\"draft-07\"},\"type\":\"body\"},{\"operator\":\"validatesXPath\",\"target\":{\"operator\":\"contains\",\"targetValue\":\"0\",\"xPath\":\"target-xpath\"},\"type\":\"body\"},{\"operator\":\"md5\",\"target\":\"a\",\"type\":\"bodyHash\"},{\"code\":\"const hello = 'world';\",\"type\":\"javascript\"}],\"configVariables\":[{\"example\":\"content-type\",\"name\":\"PROPERTY\",\"pattern\":\"content-type\",\"type\":\"text\"}],\"request\":{\"basicAuth\":{\"accessTokenUrl\":\"https://datadog-token.com\",\"audience\":\"audience\",\"clientId\":\"client-id\",\"clientSecret\":\"client-secret\",\"resource\":\"resource\",\"scope\":\"yoyo\",\"tokenApiAuthentication\":\"header\",\"type\":\"oauth-client\"},\"certificate\":{\"cert\":{\"content\":\"cert-content\",\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"content\":\"key-content\",\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testcreateamultisteptestwithsubtestreturnsokresponse1766762565\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"type\":\"api\"}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/api"
+        },
+        "response": {
+          "bodySize": 2672,
+          "content": {
+            "mimeType": "application/json",
+            "size": 2672,
+            "text": "{\"public_id\":\"f8v-zk3-x5h\",\"name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"status\":\"live\",\"type\":\"api\",\"subtype\":\"http\",\"tags\":[\"testing:api\"],\"created_at\":\"2025-12-26T15:22:45.449340+00:00\",\"modified_at\":\"2025-12-26T15:22:45.449340+00:00\",\"config\":{\"assertions\":[{\"operator\":\"is\",\"property\":\"{{ PROPERTY }}\",\"target\":\"text/html\",\"type\":\"header\"},{\"operator\":\"lessThan\",\"target\":2000,\"timingsScope\":\"withoutDNS\",\"type\":\"responseTime\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONPath\",\"target\":{\"elementsOperator\":\"atLeastOneElementMatches\",\"jsonPath\":\"topKey\",\"operator\":\"isNot\",\"targetValue\":\"0\"},\"type\":\"body\"},{\"operator\":\"validatesJSONSchema\",\"target\":{\"jsonSchema\":\"{\\\"type\\\": \\\"object\\\", \\\"properties\\\":{\\\"slideshow\\\":{\\\"type\\\":\\\"object\\\"}}}\",\"metaSchema\":\"draft-07\"},\"type\":\"body\"},{\"operator\":\"validatesXPath\",\"target\":{\"operator\":\"contains\",\"targetValue\":\"0\",\"xPath\":\"target-xpath\"},\"type\":\"body\"},{\"operator\":\"md5\",\"target\":\"a\",\"type\":\"bodyHash\"},{\"code\":\"const hello = 'world';\",\"type\":\"javascript\"}],\"configVariables\":[{\"example\":\"content-type\",\"name\":\"PROPERTY\",\"pattern\":\"content-type\",\"type\":\"text\"}],\"request\":{\"basicAuth\":{\"accessTokenUrl\":\"https://datadog-token.com\",\"audience\":\"audience\",\"clientId\":\"client-id\",\"clientSecret\":\"client-secret\",\"resource\":\"resource\",\"scope\":\"yoyo\",\"tokenApiAuthentication\":\"header\",\"type\":\"oauth-client\"},\"certificate\":{\"cert\":{\"filename\":\"cert-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"},\"key\":{\"filename\":\"key-filename\",\"updatedAt\":\"2020-10-16T09:23:24.857Z\"}},\"headers\":{\"unique\":\"testcreateamultisteptestwithsubtestreturnsokresponse1766762565\"},\"method\":\"GET\",\"persistCookies\":true,\"proxy\":{\"headers\":{},\"url\":\"https://datadoghq.com\"},\"timeout\":10,\"url\":\"https://datadoghq.com\"},\"variablesFromScript\":\"dd.variable.set(\\\"FOO\\\", \\\"foo\\\")\"},\"message\":\"BDD test payload: synthetics_api_http_test_payload.json\",\"options\":{\"accept_self_signed\":false,\"allow_insecure\":true,\"follow_redirects\":true,\"httpVersion\":\"http2\",\"min_failure_duration\":10,\"min_location_failed\":1,\"monitor_name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"monitor_priority\":5,\"retry\":{\"count\":3,\"interval\":10},\"tick_every\":60},\"locations\":[\"aws:us-east-2\"],\"created_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"team-intg-tools-libs-spam@datadoghq.com\"},\"deleted_at\":null,\"monitor_id\":246774114,\"org_id\":321813,\"modified_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"team-intg-tools-libs-spam@datadoghq.com\"}}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 694,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-26T15:22:45.124Z",
+        "time": 408
+      },
+      {
+        "_id": "123c3f3ada86427b2d826ff1554c902b",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 586,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 578,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"config\":{\"steps\":[{\"assertions\":[{\"operator\":\"is\",\"target\":200,\"type\":\"statusCode\"}],\"name\":\"request is sent\",\"request\":{\"basicAuth\":{\"password\":\"password\",\"username\":\"username\"},\"method\":\"GET\",\"url\":\"https://httpbin.org/status/200\"},\"subtype\":\"http\"},{\"name\":\"subtest step\",\"subtestPublicId\":\"f8v-zk3-x5h\",\"subtype\":\"playSubTest\"}]},\"locations\":[\"aws:us-east-2\"],\"message\":\"BDD test payload: synthetics_api_test_multi_step_with_subtest.json\",\"name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"options\":{\"tick_every\":60},\"subtype\":\"multi\",\"type\":\"api\"}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/api"
+        },
+        "response": {
+          "bodySize": 1098,
+          "content": {
+            "mimeType": "application/json",
+            "size": 1098,
+            "text": "{\"public_id\":\"5kg-4fz-eh9\",\"name\":\"Test-Create_a_multistep_test_with_subtest_returns_OK_response-1766762565\",\"status\":\"live\",\"type\":\"api\",\"subtype\":\"multi\",\"tags\":[],\"created_at\":\"2025-12-26T15:22:45.980687+00:00\",\"modified_at\":\"2025-12-26T15:22:45.980687+00:00\",\"config\":{\"steps\":[{\"assertions\":[{\"operator\":\"is\",\"target\":200,\"type\":\"statusCode\"}],\"name\":\"request is sent\",\"request\":{\"basicAuth\":{\"password\":\"password\",\"username\":\"username\"},\"method\":\"GET\",\"url\":\"https://httpbin.org/status/200\"},\"subtype\":\"http\",\"id\":\"cyy-kz8-9b6\"},{\"name\":\"subtest step\",\"subtestPublicId\":\"f8v-zk3-x5h\",\"subtype\":\"playSubTest\",\"id\":\"se7-rsj-k3p\"}]},\"message\":\"BDD test payload: synthetics_api_test_multi_step_with_subtest.json\",\"options\":{\"tick_every\":60},\"locations\":[\"aws:us-east-2\"],\"created_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"team-intg-tools-libs-spam@datadoghq.com\"},\"deleted_at\":null,\"monitor_id\":246774122,\"org_id\":321813,\"modified_by\":{\"name\":\"CI Account\",\"handle\":\"9919ec9b-ebc7-49ee-8dc8-03626e717cca\",\"email\":\"team-intg-tools-libs-spam@datadoghq.com\"}}"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 694,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-26T15:22:45.540Z",
+        "time": 603
+      },
+      {
+        "_id": "54491da2fbfa2588131ab10b8d962034",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 30,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 568,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"public_ids\":[\"5kg-4fz-eh9\"]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/delete"
+        },
+        "response": {
+          "bodySize": 96,
+          "content": {
+            "mimeType": "application/json",
+            "size": 96,
+            "text": "{\"deleted_tests\":[{\"public_id\":\"5kg-4fz-eh9\",\"deleted_at\":\"2025-12-26T15:22:46.386306+00:00\"}]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 693,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-26T15:22:46.149Z",
+        "time": 473
+      },
+      {
+        "_id": "711d0c79366cf9fbdac1674f371fa343",
+        "_order": 0,
+        "cache": {},
+        "request": {
+          "bodySize": 30,
+          "cookies": [],
+          "headers": [
+            {
+              "_fromType": "array",
+              "name": "accept",
+              "value": "application/json"
+            },
+            {
+              "_fromType": "array",
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 568,
+          "httpVersion": "HTTP/1.1",
+          "method": "POST",
+          "postData": {
+            "mimeType": "application/json",
+            "params": [],
+            "text": "{\"public_ids\":[\"f8v-zk3-x5h\"]}"
+          },
+          "queryString": [],
+          "url": "https://api.datadoghq.com/api/v1/synthetics/tests/delete"
+        },
+        "response": {
+          "bodySize": 96,
+          "content": {
+            "mimeType": "application/json",
+            "size": 96,
+            "text": "{\"deleted_tests\":[{\"public_id\":\"f8v-zk3-x5h\",\"deleted_at\":\"2025-12-26T15:22:46.982158+00:00\"}]}\n"
+          },
+          "cookies": [],
+          "headers": [
+            {
+              "name": "content-type",
+              "value": "application/json"
+            }
+          ],
+          "headersSize": 693,
+          "httpVersion": "HTTP/1.1",
+          "redirectURL": "",
+          "status": 200,
+          "statusText": "OK"
+        },
+        "startedDateTime": "2025-12-26T15:22:46.641Z",
+        "time": 635
+      }
+    ],
+    "pages": [],
+    "version": "1.2"
+  }
+}

examples/v1/synthetics/CreateSyntheticsAPITest_2106135939.ts

@@ -0,0 +1,63 @@
+/**
+ * Create a multistep test with subtest returns "OK" response
+ */
+
+import { client, v1 } from "@datadog/datadog-api-client";
+
+const configuration = client.createConfiguration();
+const apiInstance = new v1.SyntheticsApi(configuration);
+
+// there is a valid "synthetics_api_test" in the system
+const SYNTHETICS_API_TEST_PUBLIC_ID = process.env
+  .SYNTHETICS_API_TEST_PUBLIC_ID as string;
+
+const params: v1.SyntheticsApiCreateSyntheticsAPITestRequest = {
+  body: {
+    config: {
+      steps: [
+        {
+          assertions: [
+            {
+              operator: "is",
+              type: "statusCode",
+              target: 200,
+            },
+          ],
+          name: "request is sent",
+          request: {
+            url: "https://httpbin.org/status/200",
+            method: "GET",
+            basicAuth: {
+              password: "password",
+              username: "username",
+            },
+          },
+          subtype: "http",
+        },
+        {
+          subtype: "playSubTest",
+          subtestPublicId: SYNTHETICS_API_TEST_PUBLIC_ID,
+          name: "subtest step",
+        },
+      ],
+    },
+    locations: ["aws:us-east-2"],
+    message:
+      "BDD test payload: synthetics_api_test_multi_step_with_subtest.json",
+    name: "Example-Synthetic",
+    options: {
+      tickEvery: 60,
+    },
+    subtype: "multi",
+    type: "api",
+  },
+};
+
+apiInstance
+  .createSyntheticsAPITest(params)
+  .then((data: v1.SyntheticsAPITest) => {
+    console.log(
+      "API called successfully. Returned data: " + JSON.stringify(data)
+    );
+  })
+  .catch((error: any) => console.error(error));

features/v1/synthetics.feature

@@ -169,6 +169,14 @@ Feature: Synthetics
     And the response "config.steps[5].request.basicAuth.type" is equal to "oauth-client"
     And the response "config.steps[6].request.basicAuth.type" is equal to "oauth-rop"
 
+  @team:DataDog/synthetics-managing
+  Scenario: Create a multistep test with subtest returns "OK" response
+    Given there is a valid "synthetics_api_test" in the system
+    And new "CreateSyntheticsAPITest" request
+    And body from file "synthetics_api_test_multi_step_with_subtest.json"
+    When the request is sent
+    Then the response status is 200 OK
+
   @replay-only @team:DataDog/synthetics-managing
   Scenario: Create a private location returns "OK" response
     Given there is a valid "role" in the system