Skip to content

Commit cd780b9

Browse files
Improve oncall schedule endpoint documentation (#2812)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 2fedd1d
1 parent c729f89 commit cd780b9

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

datadog_api_client.v2.model.html

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -81537,11 +81537,11 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8153781537
<dt class="sig sig-object py">
8153881538
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">Shift</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>
8153981539
<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>
81540-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">Shift</span></code> object.</p>
81540+
<p>An on-call shift with its associated data and relationships.</p>
8154181541
<dl class="field-list simple">
8154281542
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8154381543
<dd class="field-odd"><ul class="simple">
81544-
<li><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data.ShiftData" title="datadog_api_client.v2.model.shift_data.ShiftData"><em>ShiftData</em></a><em>, </em><em>optional</em>) – The definition of <code class="docutils literal notranslate"><span class="pre">ShiftData</span></code> object.</p></li>
81544+
<li><p><strong>data</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data.ShiftData" title="datadog_api_client.v2.model.shift_data.ShiftData"><em>ShiftData</em></a><em>, </em><em>optional</em>) – Data for an on-call shift.</p></li>
8154581545
<li><p><strong>included</strong> (<em>[</em><a class="reference internal" href="#datadog_api_client.v2.model.shift_included.ShiftIncluded" title="datadog_api_client.v2.model.shift_included.ShiftIncluded"><em>ShiftIncluded</em></a><em>]</em><em>, </em><em>optional</em>) – The <code class="docutils literal notranslate"><span class="pre">Shift</span></code> <code class="docutils literal notranslate"><span class="pre">included</span></code>.</p></li>
8154681546
</ul>
8154781547
</dd>
@@ -81558,13 +81558,13 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8155881558
<dt class="sig sig-object py">
8155981559
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ShiftData</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>
8156081560
<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>
81561-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">ShiftData</span></code> object.</p>
81561+
<p>Data for an on-call shift.</p>
8156281562
<dl class="field-list simple">
8156381563
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8156481564
<dd class="field-odd"><ul class="simple">
81565-
<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_attributes.ShiftDataAttributes" title="datadog_api_client.v2.model.shift_data_attributes.ShiftDataAttributes"><em>ShiftDataAttributes</em></a><em>, </em><em>optional</em>) – The definition of <code class="docutils literal notranslate"><span class="pre">ShiftDataAttributes</span></code> object.</p></li>
81565+
<li><p><strong>attributes</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_attributes.ShiftDataAttributes" title="datadog_api_client.v2.model.shift_data_attributes.ShiftDataAttributes"><em>ShiftDataAttributes</em></a><em>, </em><em>optional</em>) – Attributes for an on-call shift.</p></li>
8156681566
<li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – The <code class="docutils literal notranslate"><span class="pre">ShiftData</span></code> <code class="docutils literal notranslate"><span class="pre">id</span></code>.</p></li>
81567-
<li><p><strong>relationships</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_relationships.ShiftDataRelationships" title="datadog_api_client.v2.model.shift_data_relationships.ShiftDataRelationships"><em>ShiftDataRelationships</em></a><em>, </em><em>optional</em>) – The definition of <code class="docutils literal notranslate"><span class="pre">ShiftDataRelationships</span></code> object.</p></li>
81567+
<li><p><strong>relationships</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_relationships.ShiftDataRelationships" title="datadog_api_client.v2.model.shift_data_relationships.ShiftDataRelationships"><em>ShiftDataRelationships</em></a><em>, </em><em>optional</em>) – Relationships for an on-call shift.</p></li>
8156881568
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_type.ShiftDataType" title="datadog_api_client.v2.model.shift_data_type.ShiftDataType"><em>ShiftDataType</em></a>) – Indicates that the resource is of type ‘shifts’.</p></li>
8156981569
</ul>
8157081570
</dd>
@@ -81581,7 +81581,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8158181581
<dt class="sig sig-object py">
8158281582
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ShiftDataAttributes</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>
8158381583
<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>
81584-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">ShiftDataAttributes</span></code> object.</p>
81584+
<p>Attributes for an on-call shift.</p>
8158581585
<dl class="field-list simple">
8158681586
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8158781587
<dd class="field-odd"><ul class="simple">
@@ -81602,7 +81602,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8160281602
<dt class="sig sig-object py">
8160381603
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ShiftDataRelationships</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>
8160481604
<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>
81605-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">ShiftDataRelationships</span></code> object.</p>
81605+
<p>Relationships for an on-call shift.</p>
8160681606
<dl class="field-list simple">
8160781607
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8160881608
<dd class="field-odd"><p><strong>user</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.shift_data_relationships_user.ShiftDataRelationshipsUser" title="datadog_api_client.v2.model.shift_data_relationships_user.ShiftDataRelationshipsUser"><em>ShiftDataRelationshipsUser</em></a><em>, </em><em>optional</em>) – Defines the relationship between a shift and the user who is working that shift.</p>
@@ -81721,7 +81721,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
8172181721
<dt class="sig sig-object py">
8172281722
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">ShiftIncluded</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>
8172381723
<dd><p>Bases: <a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.ModelComposed" title="datadog_api_client.model_utils.ModelComposed"><code class="xref py py-class docutils literal notranslate"><span class="pre">ModelComposed</span></code></a></p>
81724-
<p>The definition of <code class="docutils literal notranslate"><span class="pre">ShiftIncluded</span></code> object.</p>
81724+
<p>Included data for shift operations.</p>
8172581725
<dl class="field-list simple">
8172681726
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
8172781727
<dd class="field-odd"><ul class="simple">

0 commit comments

Comments
 (0)