Skip to content

Commit 1aba975

Browse files
Remove mobile device ids and make all device ids simple string (#2269)
* update enum list deserialization * Regenerate client from commit ebf27b5e of spec repo --------- Co-authored-by: Kevin Zou <[email protected]> Co-authored-by: api-clients-generation-pipeline[bot] <54105614+api-clients-generation-pipeline[bot]@users.noreply.github.com> Co-authored-by: ci.datadog-api-spec <[email protected]> b7de63d
1 parent 8abb0fc commit 1aba975

8 files changed

+8
-69
lines changed

_sources/datadog_api_client.v1.model.rst.txt

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4358,13 +4358,6 @@ datadog\_api\_client.v1.model.synthetics\_device module
43584358
:members:
43594359
:show-inheritance:
43604360

4361-
datadog\_api\_client.v1.model.synthetics\_device\_id module
4362-
-----------------------------------------------------------
4363-
4364-
.. automodule:: datadog_api_client.v1.model.synthetics_device_id
4365-
:members:
4366-
:show-inheritance:
4367-
43684361
datadog\_api\_client.v1.model.synthetics\_fetch\_uptimes\_payload module
43694362
------------------------------------------------------------------------
43704363

datadog_api_client.html

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1886,7 +1886,6 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
18861886
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_delete_tests_response">datadog_api_client.v1.model.synthetics_delete_tests_response module</a></li>
18871887
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_deleted_test">datadog_api_client.v1.model.synthetics_deleted_test module</a></li>
18881888
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device">datadog_api_client.v1.model.synthetics_device module</a></li>
1889-
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device_id">datadog_api_client.v1.model.synthetics_device_id module</a></li>
18901889
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload">datadog_api_client.v1.model.synthetics_fetch_uptimes_payload module</a></li>
18911890
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_get_api_test_latest_results_response">datadog_api_client.v1.model.synthetics_get_api_test_latest_results_response module</a></li>
18921891
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_get_browser_test_latest_results_response">datadog_api_client.v1.model.synthetics_get_browser_test_latest_results_response module</a></li>

datadog_api_client.v1.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3767,10 +3767,6 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
37673767
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_device.SyntheticsDevice"><code class="docutils literal notranslate"><span class="pre">SyntheticsDevice</span></code></a></li>
37683768
</ul>
37693769
</li>
3770-
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device_id">datadog_api_client.v1.model.synthetics_device_id module</a><ul>
3771-
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><code class="docutils literal notranslate"><span class="pre">SyntheticsDeviceID</span></code></a></li>
3772-
</ul>
3773-
</li>
37743770
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload">datadog_api_client.v1.model.synthetics_fetch_uptimes_payload module</a><ul>
37753771
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_fetch_uptimes_payload.SyntheticsFetchUptimesPayload"><code class="docutils literal notranslate"><span class="pre">SyntheticsFetchUptimesPayload</span></code></a></li>
37763772
</ul>

datadog_api_client.v1.model.html

Lines changed: 5 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -4417,12 +4417,6 @@
44174417
</li></ul>
44184418
</nav>
44194419
</li>
4420-
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.synthetics_device_id" class="md-nav__link">datadog_api_client.v1.model.synthetics_device_id module</a><nav class="md-nav">
4421-
<ul class="md-nav__list">
4422-
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SyntheticsDeviceID</span></code></a>
4423-
</li></ul>
4424-
</nav>
4425-
</li>
44264420
<li class="md-nav__item"><a href="#module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload" class="md-nav__link">datadog_api_client.v1.model.synthetics_fetch_uptimes_payload module</a><nav class="md-nav">
44274421
<ul class="md-nav__list">
44284422
<li class="md-nav__item"><a href="#datadog_api_client.v1.model.synthetics_fetch_uptimes_payload.SyntheticsFetchUptimesPayload" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">SyntheticsFetchUptimesPayload</span></code></a>
@@ -19529,7 +19523,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1952919523
<dl class="field-list simple">
1953019524
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
1953119525
<dd class="field-odd"><ul class="simple">
19532-
<li><p><strong>device</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><em>SyntheticsDeviceID</em></a><em>, </em><em>optional</em>) – The device ID.</p></li>
19526+
<li><p><strong>device</strong> (<em>str</em><em>, </em><em>optional</em>) – The device ID.</p></li>
1953319527
<li><p><strong>duration</strong> (<em>float</em><em>, </em><em>optional</em>) – Total duration in millisecond of the test.</p></li>
1953419528
<li><p><strong>execution_rule</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_test_execution_rule.SyntheticsTestExecutionRule" title="datadog_api_client.v1.model.synthetics_test_execution_rule.SyntheticsTestExecutionRule"><em>SyntheticsTestExecutionRule</em></a><em>, </em><em>optional</em>) – Execution rule for a Synthetic test.</p></li>
1953519529
<li><p><strong>location</strong> (<em>str</em><em>, </em><em>optional</em>) – Name of the location.</p></li>
@@ -20046,7 +20040,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
2004620040
<li><p><strong>body</strong> (<em>str</em><em>, </em><em>optional</em>) – Body to include in the test.</p></li>
2004720041
<li><p><strong>body_type</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of the data sent in a Synthetic API test.</p></li>
2004820042
<li><p><strong>cookies</strong> (<em>str</em><em>, </em><em>optional</em>) – Cookies for the request.</p></li>
20049-
<li><p><strong>device_ids</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><em>SyntheticsDeviceID</em></a><em>]</em><em>, </em><em>optional</em>) – For browser test, array with the different device IDs used to run the test.</p></li>
20043+
<li><p><strong>device_ids</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – For browser test, array with the different device IDs used to run the test.</p></li>
2005020044
<li><p><strong>follow_redirects</strong> (<em>bool</em><em>, </em><em>optional</em>) – For API HTTP test, whether or not the test should follow redirects.</p></li>
2005120045
<li><p><strong>headers</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_test_headers.SyntheticsTestHeaders" title="datadog_api_client.v1.model.synthetics_test_headers.SyntheticsTestHeaders"><em>SyntheticsTestHeaders</em></a><em>, </em><em>optional</em>) – Headers to include when performing the test.</p></li>
2005220046
<li><p><strong>locations</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – Array of locations used to run the test.</p></li>
@@ -20203,7 +20197,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
2020320197
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2020420198
<dd class="field-odd"><ul class="simple">
2020520199
<li><p><strong>height</strong> (<em>int</em>) – Screen height of the device.</p></li>
20206-
<li><p><strong>id</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><em>SyntheticsDeviceID</em></a>) – The device ID.</p></li>
20200+
<li><p><strong>id</strong> (<em>str</em>) – The device ID.</p></li>
2020720201
<li><p><strong>is_mobile</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether or not the device is a mobile.</p></li>
2020820202
<li><p><strong>name</strong> (<em>str</em>) – The device name.</p></li>
2020920203
<li><p><strong>width</strong> (<em>int</em>) – Screen width of the device.</p></li>
@@ -20212,33 +20206,6 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
2021220206
</dl>
2021320207
</dd></dl>
2021420208
</section>
20215-
<section id="module-datadog_api_client.v1.model.synthetics_device_id">
20216-
<span id="datadog-api-client-v1-model-synthetics-device-id-module"></span><h2 id="module-datadog_api_client.v1.model.synthetics_device_id">datadog_api_client.v1.model.synthetics_device_id module<a class="headerlink" href="#module-datadog_api_client.v1.model.synthetics_device_id" title="Link to this heading">¶</a></h2>
20217-
<dl class="py class">
20218-
<dt class="sig sig-object py" id="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID">
20219-
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">SyntheticsDeviceID</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><a class="headerlink" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="Link to this definition">¶</a></dt>
20220-
<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>
20221-
<p>The device ID.</p>
20222-
<dl class="field-list simple">
20223-
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
20224-
<dd class="field-odd"><ul class="simple">
20225-
<li><p><strong>value</strong> (<em>str</em>) – Must be one of [“laptop_large”, “tablet”, “mobile_small”, “chrome.laptop_large”, “chrome.tablet”, “chrome.mobile_small”, “firefox.laptop_large”, “firefox.tablet”, “firefox.mobile_small”, “edge.laptop_large”, “edge.tablet”, “edge.mobile_small”].</p></li>
20226-
<li><p><strong>_check_type</strong> (<em>bool</em>) – If True, values for parameters in openapi_types
20227-
will be type checked and a TypeError will be raised if the wrong type is input.
20228-
Defaults to True.</p></li>
20229-
<li><p><strong>_path_to_item</strong> (<em>tuple/list</em>) – This is a list of keys or values to drill down to
20230-
the model in received_data when deserializing a response.</p></li>
20231-
<li><p><strong>_spec_property_naming</strong> (<em>bool</em>) – True if the variable names in the input
20232-
data are serialized names, as specified in the OpenAPI document. False if the
20233-
variable names in the input data are pythonic names, e.g. snake case (default).</p></li>
20234-
<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
20235-
file_type parameter. If passed, type conversion is attempted If omitted no
20236-
type conversion is done.</p></li>
20237-
</ul>
20238-
</dd>
20239-
</dl>
20240-
</dd></dl>
20241-
</section>
2024220209
<section id="module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload">
2024320210
<span id="datadog-api-client-v1-model-synthetics-fetch-uptimes-payload-module"></span><h2 id="module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload">datadog_api_client.v1.model.synthetics_fetch_uptimes_payload module<a class="headerlink" href="#module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload" title="Link to this heading">¶</a></h2>
2024420211
<dl class="py class">
@@ -21666,7 +21633,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
2166621633
<li><p><strong>allow_insecure</strong> (<em>bool</em><em>, </em><em>optional</em>) – Allows loading insecure content for an HTTP request in an API test.</p></li>
2166721634
<li><p><strong>check_certificate_revocation</strong> (<em>bool</em><em>, </em><em>optional</em>) – For SSL test, whether or not the test should fail on revoked certificate in stapled OCSP.</p></li>
2166821635
<li><p><strong>ci</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_test_ci_options.SyntheticsTestCiOptions" title="datadog_api_client.v1.model.synthetics_test_ci_options.SyntheticsTestCiOptions"><em>SyntheticsTestCiOptions</em></a><em>, </em><em>optional</em>) – CI/CD options for a Synthetic test.</p></li>
21669-
<li><p><strong>device_ids</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><em>SyntheticsDeviceID</em></a><em>]</em><em>, </em><em>optional</em>) – For browser test, array with the different device IDs used to run the test.</p></li>
21636+
<li><p><strong>device_ids</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>optional</em>) – For browser test, array with the different device IDs used to run the test.</p></li>
2167021637
<li><p><strong>disable_cors</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether or not to disable CORS mechanism.</p></li>
2167121638
<li><p><strong>disable_csp</strong> (<em>bool</em><em>, </em><em>optional</em>) – Disable Content Security Policy for browser tests.</p></li>
2167221639
<li><p><strong>enable_profiling</strong> (<em>bool</em><em>, </em><em>optional</em>) – Enable profiling for browser tests.</p></li>
@@ -22145,7 +22112,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
2214522112
<dl class="field-list simple">
2214622113
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
2214722114
<dd class="field-odd"><ul class="simple">
22148-
<li><p><strong>device</strong> (<a class="reference internal" href="#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID" title="datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID"><em>SyntheticsDeviceID</em></a><em>, </em><em>optional</em>) – The device ID.</p></li>
22115+
<li><p><strong>device</strong> (<em>str</em><em>, </em><em>optional</em>) – The device ID.</p></li>
2214922116
<li><p><strong>location</strong> (<em>int</em><em>, </em><em>optional</em>) – The location ID of the test run.</p></li>
2215022117
<li><p><strong>public_id</strong> (<em>str</em><em>, </em><em>optional</em>) – The public ID of the Synthetic test.</p></li>
2215122118
<li><p><strong>result_id</strong> (<em>str</em><em>, </em><em>optional</em>) – ID of the result.</p></li>

genindex.html

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -6787,13 +6787,6 @@ <h2 id="D">D</h2>
67876787

67886788
<ul>
67896789
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device">module</a>
6790-
</li>
6791-
</ul></li>
6792-
<li>
6793-
datadog_api_client.v1.model.synthetics_device_id
6794-
6795-
<ul>
6796-
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device_id">module</a>
67976790
</li>
67986791
</ul></li>
67996792
<li>
@@ -12053,15 +12046,15 @@ <h2 id="D">D</h2>
1205312046
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.custom_destination_response_forward_destination_http">module</a>
1205412047
</li>
1205512048
</ul></li>
12056-
</ul></td>
12057-
<td style="width: 33%; vertical-align: top;"><ul>
1205812049
<li>
1205912050
datadog_api_client.v2.model.custom_destination_response_forward_destination_http_type
1206012051

1206112052
<ul>
1206212053
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.custom_destination_response_forward_destination_http_type">module</a>
1206312054
</li>
1206412055
</ul></li>
12056+
</ul></td>
12057+
<td style="width: 33%; vertical-align: top;"><ul>
1206512058
<li>
1206612059
datadog_api_client.v2.model.custom_destination_response_forward_destination_splunk
1206712060

@@ -25372,8 +25365,6 @@ <h2 id="M">M</h2>
2537225365
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_deleted_test">datadog_api_client.v1.model.synthetics_deleted_test</a>
2537325366
</li>
2537425367
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device">datadog_api_client.v1.model.synthetics_device</a>
25375-
</li>
25376-
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device_id">datadog_api_client.v1.model.synthetics_device_id</a>
2537725368
</li>
2537825369
<li><a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_fetch_uptimes_payload">datadog_api_client.v1.model.synthetics_fetch_uptimes_payload</a>
2537925370
</li>
@@ -31703,8 +31694,6 @@ <h2 id="S">S</h2>
3170331694
<li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_delete_tests_response.SyntheticsDeleteTestsResponse">SyntheticsDeleteTestsResponse (class in datadog_api_client.v1.model.synthetics_delete_tests_response)</a>
3170431695
</li>
3170531696
<li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_device.SyntheticsDevice">SyntheticsDevice (class in datadog_api_client.v1.model.synthetics_device)</a>
31706-
</li>
31707-
<li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_device_id.SyntheticsDeviceID">SyntheticsDeviceID (class in datadog_api_client.v1.model.synthetics_device_id)</a>
3170831697
</li>
3170931698
<li><a href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.synthetics_fetch_uptimes_payload.SyntheticsFetchUptimesPayload">SyntheticsFetchUptimesPayload (class in datadog_api_client.v1.model.synthetics_fetch_uptimes_payload)</a>
3171031699
</li>

objects.inv

-12 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4005,11 +4005,6 @@ <h1>Python Module Index</h1>
40054005
<td>&#160;&#160;&#160;
40064006
<a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device"><code class="xref">datadog_api_client.v1.model.synthetics_device</code></a></td><td>
40074007
<em></em></td></tr>
4008-
<tr class="cg-1">
4009-
<td></td>
4010-
<td>&#160;&#160;&#160;
4011-
<a href="datadog_api_client.v1.model.html#module-datadog_api_client.v1.model.synthetics_device_id"><code class="xref">datadog_api_client.v1.model.synthetics_device_id</code></a></td><td>
4012-
<em></em></td></tr>
40134008
<tr class="cg-1">
40144009
<td></td>
40154010
<td>&#160;&#160;&#160;

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)