Add subtest for synthetics multistep tests (#3042)

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

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

_sources/datadog_api_client.v1.model.rst.txt

@@ -4134,6 +4134,20 @@ datadog\_api\_client.v1.model.synthetics\_api\_step module
    :members:
    :show-inheritance:
 
+datadog\_api\_client.v1.model.synthetics\_api\_subtest\_step module
+-------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_api_subtest_step
+   :members:
+   :show-inheritance:
+
+datadog\_api\_client.v1.model.synthetics\_api\_subtest\_step\_subtype module
+----------------------------------------------------------------------------
+
+.. automodule:: datadog_api_client.v1.model.synthetics_api_subtest_step_subtype
+   :members:
+   :show-inheritance:
+
 datadog\_api\_client.v1.model.synthetics\_api\_test module
 ----------------------------------------------------------
 

datadog_api_client.html

@@ -2023,6 +2023,8 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.sunburst_widget_legend_table_type">datadog_api_client.v1.model.sunburst_widget_legend_table_type module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.sunburst_widget_request">datadog_api_client.v1.model.sunburst_widget_request module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_step">datadog_api_client.v1.model.synthetics_api_step module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_subtest_step">datadog_api_client.v1.model.synthetics_api_subtest_step module</a></li>
+<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype">datadog_api_client.v1.model.synthetics_api_subtest_step_subtype module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_test">datadog_api_client.v1.model.synthetics_api_test module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_test_config">datadog_api_client.v1.model.synthetics_api_test_config module</a></li>
 <li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_test_failure_code">datadog_api_client.v1.model.synthetics_api_test_failure_code module</a></li>

datadog_api_client.v1.html

@@ -3722,6 +3722,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_api_step.SyntheticsAPIStep"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPIStep</span></code></a></li>
 </ul>
 </li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_subtest_step">datadog_api_client.v1.model.synthetics_api_subtest_step module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_api_subtest_step.SyntheticsAPISubtestStep"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPISubtestStep</span></code></a></li>
+</ul>
+</li>
+<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype">datadog_api_client.v1.model.synthetics_api_subtest_step_subtype module</a><ul>
+<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPISubtestStepSubtype</span></code></a></li>
+</ul>
+</li>
 <li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_api_test">datadog_api_client.v1.model.synthetics_api_test module</a><ul>
 <li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_api_test.SyntheticsAPITest"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPITest</span></code></a></li>
 </ul>

datadog_api_client.v1.model.html

@@ -4302,6 +4302,18 @@
         </li></ul>
             </nav>
         </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.synthetics_api_subtest_step" class="md-nav__link">datadog_api_client.v1.model.synthetics_api_subtest_step module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.model.synthetics_api_subtest_step.SyntheticsAPISubtestStep" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPISubtestStep</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
+        <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype" class="md-nav__link">datadog_api_client.v1.model.synthetics_api_subtest_step_subtype module</a><nav class="md-nav">
+              <ul class="md-nav__list">
+        <li class="md-nav__item"><a href="#datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPISubtestStepSubtype</span></code></a>
+        </li></ul>
+            </nav>
+        </li>
         <li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.synthetics_api_test" class="md-nav__link">datadog_api_client.v1.model.synthetics_api_test module</a><nav class="md-nav">
               <ul class="md-nav__list">
         <li class="md-nav__item"><a href="#datadog_api_client.v1.model.synthetics_api_test.SyntheticsAPITest" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SyntheticsAPITest</span></code></a>
@@ -22406,6 +22418,69 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <li><p><strong>retry</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_test_options_retry.SyntheticsTestOptionsRetry" title="datadog_api_client.v1.model.synthetics_test_options_retry.SyntheticsTestOptionsRetry"><em>SyntheticsTestOptionsRetry</em></a><em>, </em><em>optional</em>) – Object describing the retry strategy to apply to a Synthetic test.</p></li>
 <li><p><strong>subtype</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_api_test_step_subtype.SyntheticsAPITestStepSubtype" title="datadog_api_client.v1.model.synthetics_api_test_step_subtype.SyntheticsAPITestStepSubtype"><em>SyntheticsAPITestStepSubtype</em></a>) – The subtype of the Synthetic multi-step API test step.</p></li>
 <li><p><strong>value</strong> (<em>int</em>) – The time to wait in seconds. Minimum value: 0. Maximum value: 180.</p></li>
+<li><p><strong>always_execute</strong> (<em>bool</em><em>, </em><em>optional</em>) – A boolean set to always execute this step even if the previous step failed or was skipped.</p></li>
+<li><p><strong>subtest_public_id</strong> (<em>str</em>) – Public ID of the test to be played as part of a <cite>playSubTest</cite> step type.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
+<section id="module-datadog_api_client.v1.model.synthetics_api_subtest_step">
+<span id="datadog-api-client-v1-model-synthetics-api-subtest-step-module"></span><h2 id="module-datadog_api_client.v1.model.synthetics_api_subtest_step">datadog_api_client.v1.model.synthetics_api_subtest_step module<a class="headerlink" href="#module-datadog_api_client.v1.model.synthetics_api_subtest_step" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v1.model.synthetics_api_subtest_step.SyntheticsAPISubtestStep">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.synthetics_api_subtest_step.SyntheticsAPISubtestStep" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStep</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelNormal" title="datadog_api_client.model_utils.ModelNormal"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelNormal</span></code></a></p>
+<p>The subtest step used in a Synthetics multi-step API test.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>allow_failure</strong> (<em>bool</em><em>, </em><em>optional</em>) – Determines whether or not to continue with test if this step fails.</p></li>
+<li><p><strong>always_execute</strong> (<em>bool</em><em>, </em><em>optional</em>) – A boolean set to always execute this step even if the previous step failed or was skipped.</p></li>
+<li><p><strong>exit_if_succeed</strong> (<em>bool</em><em>, </em><em>optional</em>) – Determines whether or not to exit the test if the step succeeds.</p></li>
+<li><p><strong>extracted_values_from_script</strong> (<em>str</em><em>, </em><em>optional</em>) – Generate variables using JavaScript.</p></li>
+<li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the step.</p></li>
+<li><p><strong>is_critical</strong> (<em>bool</em><em>, </em><em>optional</em>) – Determines whether or not to consider the entire test as failed if this step fails.
+Can be used only if <code class="docutils literal notranslate"><span class="pre">allowFailure</span></code> is <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p></li>
+<li><p><strong>name</strong> (<em>str</em>) – The name of the step.</p></li>
+<li><p><strong>retry</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_test_options_retry.SyntheticsTestOptionsRetry" title="datadog_api_client.v1.model.synthetics_test_options_retry.SyntheticsTestOptionsRetry"><em>SyntheticsTestOptionsRetry</em></a><em>, </em><em>optional</em>) – Object describing the retry strategy to apply to a Synthetic test.</p></li>
+<li><p><strong>subtest_public_id</strong> (<em>str</em>) – Public ID of the test to be played as part of a <code class="docutils literal notranslate"><span class="pre">playSubTest</span></code> step type.</p></li>
+<li><p><strong>subtype</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype" title="datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype"><em>SyntheticsAPISubtestStepSubtype</em></a>) – The subtype of the Synthetic multi-step API subtest step.</p></li>
+</ul>
+</dd>
+</dl>
+</dd></dl>
+</section>
+<section id="module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype">
+<span id="datadog-api-client-v1-model-synthetics-api-subtest-step-subtype-module"></span><h2 id="module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype">datadog_api_client.v1.model.synthetics_api_subtest_step_subtype module<a class="headerlink" href="#module-datadog_api_client.v1.model.synthetics_api_subtest_step_subtype" title="Link to this heading">¶</a></h2>
+<dl class="py class">
+<dt class="sig sig-object py" id="datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStepSubtype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v1.model.synthetics_api_subtest_step_subtype.SyntheticsAPISubtestStepSubtype" title="Link to this definition">¶</a></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStepSubtype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">arg</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><span class="pre">ModelComposed</span></a></span></em><span class="sig-paren">)</span></dt>
+<dt class="sig sig-object py">
+<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsAPISubtestStepSubtype</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="o"><span class="pre">*</span></span><span class="n"><span class="pre">args</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span></dt>
+<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelSimple" title="datadog_api_client.model_utils.ModelSimple"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelSimple</span></code></a></p>
+<p>The subtype of the Synthetic multi-step API subtest step.</p>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>value</strong> (<em>str</em>) – If omitted defaults to “playSubTest”. Must be one of [“playSubTest”].</p></li>
+<li><p><strong>_check_type</strong> (<em>bool</em>) – If True, values for parameters in openapi_types
+will be type checked and a TypeError will be raised if the wrong type is input.
+Defaults to True.</p></li>
+<li><p><strong>_path_to_item</strong> (<em>tuple/list</em>) – This is a list of keys or values to drill down to
+the model in received_data when deserializing a response.</p></li>
+<li><p><strong>_spec_property_naming</strong> (<em>bool</em>) – True if the variable names in the input
+data are serialized names, as specified in the OpenAPI document.  False if the
+variable names in the input data are pythonic names, e.g. snake case (default).</p></li>
+<li><p><strong>_configuration</strong> (<a class="reference internal" href="datadog_api_client.v1.html#datadog_api_client.v1.Configuration" title="datadog_api_client.v1.Configuration"><em>Configuration</em></a>) – The instance to use when deserializing a
+file_type parameter.  If passed, type conversion is attempted If omitted no
+type conversion is done.</p></li>
 </ul>
 </dd>
 </dl>