Skip to content

Commit 13eeb32

Browse files
Document case management attributes endpoints (#2719)
Co-authored-by: ci.datadog-api-spec <[email protected]> 720f5e8
1 parent ab722ac commit 13eeb32

9 files changed

+236
-7
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2118,6 +2118,13 @@ datadog\_api\_client.v2.model.case\_empty\_request module
21182118
:members:
21192119
:show-inheritance:
21202120

2121+
datadog\_api\_client.v2.model.case\_object\_attributes module
2122+
-------------------------------------------------------------
2123+
2124+
.. automodule:: datadog_api_client.v2.model.case_object_attributes
2125+
:members:
2126+
:show-inheritance:
2127+
21212128
datadog\_api\_client.v2.model.case\_priority module
21222129
---------------------------------------------------
21232130

@@ -2181,6 +2188,27 @@ datadog\_api\_client.v2.model.case\_type module
21812188
:members:
21822189
:show-inheritance:
21832190

2191+
datadog\_api\_client.v2.model.case\_update\_attributes module
2192+
-------------------------------------------------------------
2193+
2194+
.. automodule:: datadog_api_client.v2.model.case_update_attributes
2195+
:members:
2196+
:show-inheritance:
2197+
2198+
datadog\_api\_client.v2.model.case\_update\_attributes\_attributes module
2199+
-------------------------------------------------------------------------
2200+
2201+
.. automodule:: datadog_api_client.v2.model.case_update_attributes_attributes
2202+
:members:
2203+
:show-inheritance:
2204+
2205+
datadog\_api\_client.v2.model.case\_update\_attributes\_request module
2206+
----------------------------------------------------------------------
2207+
2208+
.. automodule:: datadog_api_client.v2.model.case_update_attributes_request
2209+
:members:
2210+
:show-inheritance:
2211+
21842212
datadog\_api\_client.v2.model.case\_update\_priority module
21852213
-----------------------------------------------------------
21862214

datadog_api_client.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2636,6 +2636,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
26362636
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_create_request">datadog_api_client.v2.model.case_create_request module</a></li>
26372637
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_empty">datadog_api_client.v2.model.case_empty module</a></li>
26382638
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_empty_request">datadog_api_client.v2.model.case_empty_request module</a></li>
2639+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_object_attributes">datadog_api_client.v2.model.case_object_attributes module</a></li>
26392640
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_priority">datadog_api_client.v2.model.case_priority module</a></li>
26402641
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_relationships">datadog_api_client.v2.model.case_relationships module</a></li>
26412642
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_resource_type">datadog_api_client.v2.model.case_resource_type module</a></li>
@@ -2645,6 +2646,9 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
26452646
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_trigger">datadog_api_client.v2.model.case_trigger module</a></li>
26462647
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_trigger_wrapper">datadog_api_client.v2.model.case_trigger_wrapper module</a></li>
26472648
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_type">datadog_api_client.v2.model.case_type module</a></li>
2649+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes">datadog_api_client.v2.model.case_update_attributes module</a></li>
2650+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes_attributes">datadog_api_client.v2.model.case_update_attributes_attributes module</a></li>
2651+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes_request">datadog_api_client.v2.model.case_update_attributes_request module</a></li>
26482652
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_priority">datadog_api_client.v2.model.case_update_priority module</a></li>
26492653
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_priority_attributes">datadog_api_client.v2.model.case_update_priority_attributes module</a></li>
26502654
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_priority_request">datadog_api_client.v2.model.case_update_priority_request module</a></li>

datadog_api_client.v2.api.html

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -909,6 +909,8 @@
909909
</li>
910910
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.unassign_case" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.unassign_case()</span></code></a>
911911
</li>
912+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_attributes" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_attributes()</span></code></a>
913+
</li>
912914
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_priority" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_priority()</span></code></a>
913915
</li>
914916
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_status" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_status()</span></code></a>
@@ -3629,6 +3631,23 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
36293631
</dl>
36303632
</dd></dl>
36313633
<dl class="py method">
3634+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_attributes">
3635+
<span class="sig-name descname"><span class="pre">update_attributes</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.case_update_attributes_request.CaseUpdateAttributesRequest" title="datadog_api_client.v2.model.case_update_attributes_request.CaseUpdateAttributesRequest"><span class="pre">CaseUpdateAttributesRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_response.CaseResponse" title="datadog_api_client.v2.model.case_response.CaseResponse"><span class="pre">CaseResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_attributes" title="Link to this definition">¶</a></dt>
3636+
<dd><p>Update case attributes.</p>
3637+
<p>Update case attributes</p>
3638+
<dl class="field-list simple">
3639+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
3640+
<dd class="field-odd"><ul class="simple">
3641+
<li><p><strong>case_id</strong> (<em>str</em>) – Case’s UUID or key</p></li>
3642+
<li><p><strong>body</strong> (<a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_update_attributes_request.CaseUpdateAttributesRequest" title="datadog_api_client.v2.model.case_update_attributes_request.CaseUpdateAttributesRequest"><em>CaseUpdateAttributesRequest</em></a>) – Case attributes update payload</p></li>
3643+
</ul>
3644+
</dd>
3645+
<dt class="field-even">Return type<span class="colon">:</span></dt>
3646+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_response.CaseResponse" title="datadog_api_client.v2.model.case_response.CaseResponse">CaseResponse</a></p>
3647+
</dd>
3648+
</dl>
3649+
</dd></dl>
3650+
<dl class="py method">
36323651
<dt class="sig sig-object py" id="datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_priority">
36333652
<span class="sig-name descname"><span class="pre">update_priority</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">case_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">str</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">body</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.v2.model.html#datadog_api_client.v2.model.case_update_priority_request.CaseUpdatePriorityRequest" title="datadog_api_client.v2.model.case_update_priority_request.CaseUpdatePriorityRequest"><span class="pre">CaseUpdatePriorityRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_response.CaseResponse" title="datadog_api_client.v2.model.case_response.CaseResponse"><span class="pre">CaseResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_priority" title="Link to this definition">¶</a></dt>
36343653
<dd><p>Update case priority.</p>

datadog_api_client.v2.html

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -979,6 +979,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
979979
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.search_cases_with_pagination"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.search_cases_with_pagination()</span></code></a></li>
980980
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.unarchive_case"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.unarchive_case()</span></code></a></li>
981981
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.unassign_case"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.unassign_case()</span></code></a></li>
982+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_attributes"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_attributes()</span></code></a></li>
982983
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_priority"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_priority()</span></code></a></li>
983984
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.case_management_api.CaseManagementApi.update_status"><code class="docutils literal notranslate"><span class="pre">CaseManagementApi.update_status()</span></code></a></li>
984985
</ul>
@@ -3067,6 +3068,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
30673068
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_empty_request.CaseEmptyRequest"><code class="docutils literal notranslate"><span class="pre">CaseEmptyRequest</span></code></a></li>
30683069
</ul>
30693070
</li>
3071+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_object_attributes">datadog_api_client.v2.model.case_object_attributes module</a><ul>
3072+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_object_attributes.CaseObjectAttributes"><code class="docutils literal notranslate"><span class="pre">CaseObjectAttributes</span></code></a></li>
3073+
</ul>
3074+
</li>
30703075
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_priority">datadog_api_client.v2.model.case_priority module</a><ul>
30713076
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_priority.CasePriority"><code class="docutils literal notranslate"><span class="pre">CasePriority</span></code></a></li>
30723077
</ul>
@@ -3103,6 +3108,18 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
31033108
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_type.CaseType"><code class="docutils literal notranslate"><span class="pre">CaseType</span></code></a></li>
31043109
</ul>
31053110
</li>
3111+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes">datadog_api_client.v2.model.case_update_attributes module</a><ul>
3112+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_update_attributes.CaseUpdateAttributes"><code class="docutils literal notranslate"><span class="pre">CaseUpdateAttributes</span></code></a></li>
3113+
</ul>
3114+
</li>
3115+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes_attributes">datadog_api_client.v2.model.case_update_attributes_attributes module</a><ul>
3116+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_update_attributes_attributes.CaseUpdateAttributesAttributes"><code class="docutils literal notranslate"><span class="pre">CaseUpdateAttributesAttributes</span></code></a></li>
3117+
</ul>
3118+
</li>
3119+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_attributes_request">datadog_api_client.v2.model.case_update_attributes_request module</a><ul>
3120+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_update_attributes_request.CaseUpdateAttributesRequest"><code class="docutils literal notranslate"><span class="pre">CaseUpdateAttributesRequest</span></code></a></li>
3121+
</ul>
3122+
</li>
31063123
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_update_priority">datadog_api_client.v2.model.case_update_priority module</a><ul>
31073124
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_update_priority.CaseUpdatePriority"><code class="docutils literal notranslate"><span class="pre">CaseUpdatePriority</span></code></a></li>
31083125
</ul>

0 commit comments

Comments
 (0)