Add subtest for synthetics multistep tests (#1114)

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:

examples/v1_synthetics_CreateSyntheticsAPITest_2106135939.rs

@@ -0,0 +1,71 @@
+// Create a multistep test with subtest returns "OK" response
+use datadog_api_client::datadog;
+use datadog_api_client::datadogV1::api_synthetics::SyntheticsAPI;
+use datadog_api_client::datadogV1::model::SyntheticsAPIStep;
+use datadog_api_client::datadogV1::model::SyntheticsAPISubtestStep;
+use datadog_api_client::datadogV1::model::SyntheticsAPISubtestStepSubtype;
+use datadog_api_client::datadogV1::model::SyntheticsAPITest;
+use datadog_api_client::datadogV1::model::SyntheticsAPITestConfig;
+use datadog_api_client::datadogV1::model::SyntheticsAPITestStep;
+use datadog_api_client::datadogV1::model::SyntheticsAPITestStepSubtype;
+use datadog_api_client::datadogV1::model::SyntheticsAPITestType;
+use datadog_api_client::datadogV1::model::SyntheticsAssertion;
+use datadog_api_client::datadogV1::model::SyntheticsAssertionOperator;
+use datadog_api_client::datadogV1::model::SyntheticsAssertionTarget;
+use datadog_api_client::datadogV1::model::SyntheticsAssertionTargetValue;
+use datadog_api_client::datadogV1::model::SyntheticsAssertionType;
+use datadog_api_client::datadogV1::model::SyntheticsBasicAuth;
+use datadog_api_client::datadogV1::model::SyntheticsBasicAuthWeb;
+use datadog_api_client::datadogV1::model::SyntheticsTestDetailsSubType;
+use datadog_api_client::datadogV1::model::SyntheticsTestOptions;
+use datadog_api_client::datadogV1::model::SyntheticsTestRequest;
+
+#[tokio::main]
+async fn main() {
+    // there is a valid "synthetics_api_test" in the system
+    let synthetics_api_test_public_id = std::env::var("SYNTHETICS_API_TEST_PUBLIC_ID").unwrap();
+    let body = SyntheticsAPITest::new(
+        SyntheticsAPITestConfig::new().steps(vec![
+            SyntheticsAPIStep::SyntheticsAPITestStep(Box::new(SyntheticsAPITestStep::new(
+                vec![SyntheticsAssertion::SyntheticsAssertionTarget(Box::new(
+                    SyntheticsAssertionTarget::new(
+                        SyntheticsAssertionOperator::IS,
+                        SyntheticsAssertionTargetValue::SyntheticsAssertionTargetValueNumber(
+                            200.0 as f64,
+                        ),
+                        SyntheticsAssertionType::STATUS_CODE,
+                    ),
+                ))],
+                "request is sent".to_string(),
+                SyntheticsTestRequest::new()
+                    .basic_auth(SyntheticsBasicAuth::SyntheticsBasicAuthWeb(Box::new(
+                        SyntheticsBasicAuthWeb::new()
+                            .password("password".to_string())
+                            .username("username".to_string()),
+                    )))
+                    .method("GET".to_string())
+                    .url("https://httpbin.org/status/200".to_string()),
+                SyntheticsAPITestStepSubtype::HTTP,
+            ))),
+            SyntheticsAPIStep::SyntheticsAPISubtestStep(Box::new(SyntheticsAPISubtestStep::new(
+                "subtest step".to_string(),
+                synthetics_api_test_public_id.clone(),
+                SyntheticsAPISubtestStepSubtype::PLAY_SUB_TEST,
+            ))),
+        ]),
+        vec!["aws:us-east-2".to_string()],
+        "BDD test payload: synthetics_api_test_multi_step_with_subtest.json".to_string(),
+        "Example-Synthetic".to_string(),
+        SyntheticsTestOptions::new().tick_every(60),
+        SyntheticsAPITestType::API,
+    )
+    .subtype(SyntheticsTestDetailsSubType::MULTI);
+    let configuration = datadog::Configuration::new();
+    let api = SyntheticsAPI::with_config(configuration);
+    let resp = api.create_synthetics_api_test(body).await;
+    if let Ok(value) = resp {
+        println!("{:#?}", value);
+    } else {
+        println!("{:#?}", resp.unwrap_err());
+    }
+}

src/datadogV1/model/mod.rs

@@ -1552,6 +1552,10 @@ pub mod model_synthetics_api_wait_step;
 pub use self::model_synthetics_api_wait_step::SyntheticsAPIWaitStep;
 pub mod model_synthetics_api_wait_step_subtype;
 pub use self::model_synthetics_api_wait_step_subtype::SyntheticsAPIWaitStepSubtype;
+pub mod model_synthetics_api_subtest_step;
+pub use self::model_synthetics_api_subtest_step::SyntheticsAPISubtestStep;
+pub mod model_synthetics_api_subtest_step_subtype;
+pub use self::model_synthetics_api_subtest_step_subtype::SyntheticsAPISubtestStepSubtype;
 pub mod model_synthetics_api_step;
 pub use self::model_synthetics_api_step::SyntheticsAPIStep;
 pub mod model_synthetics_api_test_type;

src/datadogV1/model/model_synthetics_api_step.rs

@@ -10,6 +10,7 @@ use serde::{Deserialize, Deserializer, Serialize};
 pub enum SyntheticsAPIStep {
     SyntheticsAPITestStep(Box<crate::datadogV1::model::SyntheticsAPITestStep>),
     SyntheticsAPIWaitStep(Box<crate::datadogV1::model::SyntheticsAPIWaitStep>),
+    SyntheticsAPISubtestStep(Box<crate::datadogV1::model::SyntheticsAPISubtestStep>),
     UnparsedObject(crate::datadog::UnparsedObject),
 }
 
@@ -33,6 +34,14 @@ impl<'de> Deserialize<'de> for SyntheticsAPIStep {
                 return Ok(SyntheticsAPIStep::SyntheticsAPIWaitStep(_v));
             }
         }
+        if let Ok(_v) = serde_json::from_value::<
+            Box<crate::datadogV1::model::SyntheticsAPISubtestStep>,
+        >(value.clone())
+        {
+            if !_v._unparsed {
+                return Ok(SyntheticsAPIStep::SyntheticsAPISubtestStep(_v));
+            }
+        }
 
         return Ok(SyntheticsAPIStep::UnparsedObject(
             crate::datadog::UnparsedObject { value },