Add subtest for synthetics multistep tests

content/en/api/v1/synthetics/request.CreateSyntheticsAPITest_2106135939.json

@@ -0,0 +1,40 @@
+{
+  "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": "123-abc-456",
+        "name": "subtest step"
+      }
+    ]
+  },
+  "locations": [
+    "aws:us-east-2"
+  ],
+  "message": "BDD test payload: synthetics_api_test_multi_step_with_subtest.json",
+  "name": "Example-Synthetic",
+  "options": {
+    "tick_every": 60
+  },
+  "subtype": "multi",
+  "type": "api"
+}

data/api/v1/CodeExamples.json

@@ -918,6 +918,11 @@
       "suffix": "_1717840259",
       "description": "Create a multi-step api test with every type of basicAuth returns \"OK - Returns the created test details.\" response"
     },
+    {
+      "group": "synthetics",
+      "suffix": "_2106135939",
+      "description": "Create a multistep test with subtest returns \"OK\" response"
+    },
     {
       "group": "synthetics",
       "suffix": "_1402674167",

data/api/v1/full_spec.yaml

@@ -14833,6 +14833,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: