Skip to content

Commit 631e145

Browse files
Add flexible status_name support for Case Management API (#3090)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> d7f1f88
1 parent 4c941a0 commit 631e145

8 files changed

Lines changed: 78 additions & 7 deletions

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3063,6 +3063,13 @@ datadog\_api\_client.v2.model.case\_status module
30633063
:members:
30643064
:show-inheritance:
30653065

3066+
datadog\_api\_client.v2.model.case\_status\_group module
3067+
--------------------------------------------------------
3068+
3069+
.. automodule:: datadog_api_client.v2.model.case_status_group
3070+
:members:
3071+
:show-inheritance:
3072+
30663073
datadog\_api\_client.v2.model.case\_trigger module
30673074
--------------------------------------------------
30683075

datadog_api_client.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2998,6 +2998,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
29982998
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_response">datadog_api_client.v2.model.case_response module</a></li>
29992999
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_sortable_field">datadog_api_client.v2.model.case_sortable_field module</a></li>
30003000
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status">datadog_api_client.v2.model.case_status module</a></li>
3001+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status_group">datadog_api_client.v2.model.case_status_group module</a></li>
30013002
<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>
30023003
<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>
30033004
<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>

datadog_api_client.v2.html

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4036,6 +4036,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
40364036
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_status.CaseStatus"><code class="docutils literal notranslate"><span class="pre">CaseStatus</span></code></a></li>
40374037
</ul>
40384038
</li>
4039+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status_group">datadog_api_client.v2.model.case_status_group module</a><ul>
4040+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_status_group.CaseStatusGroup"><code class="docutils literal notranslate"><span class="pre">CaseStatusGroup</span></code></a></li>
4041+
</ul>
4042+
</li>
40394043
<li class="toctree-l2"><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><ul>
40404044
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_trigger.CaseTrigger"><code class="docutils literal notranslate"><span class="pre">CaseTrigger</span></code></a></li>
40414045
</ul>

datadog_api_client.v2.model.html

Lines changed: 47 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3391,6 +3391,12 @@
33913391
</li></ul>
33923392
</nav>
33933393
</li>
3394+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.case_status_group" class="md-nav__link">datadog_api_client.v2.model.case_status_group module</a><nav class="md-nav">
3395+
<ul class="md-nav__list">
3396+
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.case_status_group.CaseStatusGroup" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseStatusGroup</span></code></a>
3397+
</li></ul>
3398+
</nav>
3399+
</li>
33943400
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.model.case_trigger" class="md-nav__link">datadog_api_client.v2.model.case_trigger module</a><nav class="md-nav">
33953401
<ul class="md-nav__list">
33963402
<li class="md-nav__item"><a href="#datadog_api_client.v2.model.case_trigger.CaseTrigger" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">CaseTrigger</span></code></a>
@@ -34701,7 +34707,9 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3470134707
<li><p><strong>modified_at</strong> (<em>datetime</em><em>, </em><em>none_type</em><em>, </em><em>optional</em>) – Timestamp of when the case was last modified</p></li>
3470234708
<li><p><strong>priority</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_priority.CasePriority" title="datadog_api_client.v2.model.case_priority.CasePriority"><em>CasePriority</em></a><em>, </em><em>optional</em>) – Case priority</p></li>
3470334709
<li><p><strong>service_now_ticket</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.service_now_ticket.ServiceNowTicket" title="datadog_api_client.v2.model.service_now_ticket.ServiceNowTicket"><em>ServiceNowTicket</em></a><em>, </em><em>none_type</em><em>, </em><em>optional</em>) – ServiceNow ticket attached to case</p></li>
34704-
<li><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a><em>, </em><em>optional</em>) – Case status</p></li>
34710+
<li><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a><em>, </em><em>optional</em>) – Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use <code class="docutils literal notranslate"><span class="pre">status_name</span></code> instead. <strong>Deprecated</strong>.</p></li>
34711+
<li><p><strong>status_group</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status_group.CaseStatusGroup" title="datadog_api_client.v2.model.case_status_group.CaseStatusGroup"><em>CaseStatusGroup</em></a><em>, </em><em>optional</em>) – Status group of the case.</p></li>
34712+
<li><p><strong>status_name</strong> (<em>str</em><em>, </em><em>optional</em>) – Status of the case. Must be one of the existing statuses for the case’s type.</p></li>
3470534713
<li><p><strong>title</strong> (<em>str</em><em>, </em><em>optional</em>) – Title</p></li>
3470634714
<li><p><strong>type</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_type.CaseType" title="datadog_api_client.v2.model.case_type.CaseType"><em>CaseType</em></a><em>, </em><em>optional</em>) – Case type <strong>Deprecated</strong>.</p></li>
3470734715
<li><p><strong>type_id</strong> (<em>str</em><em>, </em><em>optional</em>) – Case type UUID</p></li>
@@ -34806,6 +34814,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3480634814
<li><p><strong>custom_attributes</strong> (<em>{str:</em><em> (</em><a class="reference internal" href="#datadog_api_client.v2.model.custom_attribute_value.CustomAttributeValue" title="datadog_api_client.v2.model.custom_attribute_value.CustomAttributeValue"><em>CustomAttributeValue</em></a><em>,</em><em>)</em><em>}</em><em>, </em><em>optional</em>) – Case custom attributes</p></li>
3480734815
<li><p><strong>description</strong> (<em>str</em><em>, </em><em>optional</em>) – Description</p></li>
3480834816
<li><p><strong>priority</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_priority.CasePriority" title="datadog_api_client.v2.model.case_priority.CasePriority"><em>CasePriority</em></a><em>, </em><em>optional</em>) – Case priority</p></li>
34817+
<li><p><strong>status_name</strong> (<em>str</em><em>, </em><em>optional</em>) – Status of the case. Must be one of the existing statuses for the case’s type.</p></li>
3480934818
<li><p><strong>title</strong> (<em>str</em>) – Title</p></li>
3481034819
<li><p><strong>type_id</strong> (<em>str</em>) – Case type UUID</p></li>
3481134820
</ul>
@@ -35167,7 +35176,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3516735176
<dt class="sig sig-object py">
3516835177
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CaseStatus</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>
3516935178
<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>
35170-
<p>Case status</p>
35179+
<p>Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use <cite>status_name</cite> instead.</p>
3517135180
<dl class="field-list simple">
3517235181
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
3517335182
<dd class="field-odd"><ul class="simple">
@@ -35188,6 +35197,37 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3518835197
</dl>
3518935198
</dd></dl>
3519035199
</section>
35200+
<section id="module-datadog_api_client.v2.model.case_status_group">
35201+
<span id="datadog-api-client-v2-model-case-status-group-module"></span><h2 id="module-datadog_api_client.v2.model.case_status_group">datadog_api_client.v2.model.case_status_group module<a class="headerlink" href="#module-datadog_api_client.v2.model.case_status_group" title="Link to this heading">¶</a></h2>
35202+
<dl class="py class">
35203+
<dt class="sig sig-object py" id="datadog_api_client.v2.model.case_status_group.CaseStatusGroup">
35204+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CaseStatusGroup</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.v2.model.case_status_group.CaseStatusGroup" title="Link to this definition">¶</a></dt>
35205+
<dt class="sig sig-object py">
35206+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CaseStatusGroup</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>
35207+
<dt class="sig sig-object py">
35208+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">CaseStatusGroup</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>
35209+
<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>
35210+
<p>Status group of the case.</p>
35211+
<dl class="field-list simple">
35212+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
35213+
<dd class="field-odd"><ul class="simple">
35214+
<li><p><strong>value</strong> (<em>str</em>) – Must be one of [“SG_OPEN”, “SG_IN_PROGRESS”, “SG_CLOSED”].</p></li>
35215+
<li><p><strong>_check_type</strong> (<em>bool</em>) – If True, values for parameters in openapi_types
35216+
will be type checked and a TypeError will be raised if the wrong type is input.
35217+
Defaults to True.</p></li>
35218+
<li><p><strong>_path_to_item</strong> (<em>tuple/list</em>) – This is a list of keys or values to drill down to
35219+
the model in received_data when deserializing a response.</p></li>
35220+
<li><p><strong>_spec_property_naming</strong> (<em>bool</em>) – True if the variable names in the input
35221+
data are serialized names, as specified in the OpenAPI document. False if the
35222+
variable names in the input data are pythonic names, e.g. snake case (default).</p></li>
35223+
<li><p><strong>_configuration</strong> (<a class="reference internal" href="datadog_api_client.v2.html#datadog_api_client.v2.Configuration" title="datadog_api_client.v2.Configuration"><em>Configuration</em></a>) – The instance to use when deserializing a
35224+
file_type parameter. If passed, type conversion is attempted If omitted no
35225+
type conversion is done.</p></li>
35226+
</ul>
35227+
</dd>
35228+
</dl>
35229+
</dd></dl>
35230+
</section>
3519135231
<section id="module-datadog_api_client.v2.model.case_trigger">
3519235232
<span id="datadog-api-client-v2-model-case-trigger-module"></span><h2 id="module-datadog_api_client.v2.model.case_trigger">datadog_api_client.v2.model.case_trigger module<a class="headerlink" href="#module-datadog_api_client.v2.model.case_trigger" title="Link to this heading">¶</a></h2>
3519335233
<dl class="py class">
@@ -35653,7 +35693,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
3565335693
<p>Case update status attributes</p>
3565435694
<dl class="field-list simple">
3565535695
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
35656-
<dd class="field-odd"><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a>) – Case status</p>
35696+
<dd class="field-odd"><ul class="simple">
35697+
<li><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a><em>, </em><em>optional</em>) – Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use <code class="docutils literal notranslate"><span class="pre">status_name</span></code> instead. <strong>Deprecated</strong>.</p></li>
35698+
<li><p><strong>status_name</strong> (<em>str</em><em>, </em><em>optional</em>) – Status of the case. Must be one of the existing statuses for the case’s type.</p></li>
35699+
</ul>
3565735700
</dd>
3565835701
</dl>
3565935702
</dd></dl>
@@ -67561,7 +67604,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
6756167604
<li><p><strong>key</strong> (<em>str</em><em>, </em><em>optional</em>) – Key of the case.</p></li>
6756267605
<li><p><strong>modified_at</strong> (<em>datetime</em><em>, </em><em>optional</em>) – Timestamp of when the case was last modified.</p></li>
6756367606
<li><p><strong>priority</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_priority.CasePriority" title="datadog_api_client.v2.model.case_priority.CasePriority"><em>CasePriority</em></a><em>, </em><em>optional</em>) – Case priority</p></li>
67564-
<li><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a><em>, </em><em>optional</em>) – Case status</p></li>
67607+
<li><p><strong>status</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.case_status.CaseStatus" title="datadog_api_client.v2.model.case_status.CaseStatus"><em>CaseStatus</em></a><em>, </em><em>optional</em>) – Deprecated way of representing the case status, which only supports OPEN, IN_PROGRESS, and CLOSED statuses. Use <code class="docutils literal notranslate"><span class="pre">status_name</span></code> instead. <strong>Deprecated</strong>.</p></li>
6756567608
<li><p><strong>title</strong> (<em>str</em><em>, </em><em>optional</em>) – Title of the case.</p></li>
6756667609
<li><p><strong>type</strong> (<em>str</em><em>, </em><em>optional</em>) – Type of the case.</p></li>
6756767610
</ul>

genindex.html

Lines changed: 13 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2100,6 +2100,8 @@ <h2 id="C">C</h2>
21002100
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cases_response_meta_pagination.CasesResponseMetaPagination">CasesResponseMetaPagination (class in datadog_api_client.v2.model.cases_response_meta_pagination)</a>
21012101
</li>
21022102
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_status.CaseStatus">CaseStatus (class in datadog_api_client.v2.model.case_status)</a>
2103+
</li>
2104+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_status_group.CaseStatusGroup">CaseStatusGroup (class in datadog_api_client.v2.model.case_status_group)</a>
21032105
</li>
21042106
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.case_trigger.CaseTrigger">CaseTrigger (class in datadog_api_client.v2.model.case_trigger)</a>
21052107
</li>
@@ -2758,11 +2760,11 @@ <h2 id="C">C</h2>
27582760
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_attribution_tag_names.CostAttributionTagNames">CostAttributionTagNames (class in datadog_api_client.v2.model.cost_attribution_tag_names)</a>
27592761
</li>
27602762
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_attribution_type.CostAttributionType">CostAttributionType (class in datadog_api_client.v2.model.cost_attribution_type)</a>
2761-
</li>
2762-
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_by_org.CostByOrg">CostByOrg (class in datadog_api_client.v2.model.cost_by_org)</a>
27632763
</li>
27642764
</ul></td>
27652765
<td style="width: 33%; vertical-align: top;"><ul>
2766+
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_by_org.CostByOrg">CostByOrg (class in datadog_api_client.v2.model.cost_by_org)</a>
2767+
</li>
27662768
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_by_org_attributes.CostByOrgAttributes">CostByOrgAttributes (class in datadog_api_client.v2.model.cost_by_org_attributes)</a>
27672769
</li>
27682770
<li><a href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.cost_by_org_response.CostByOrgResponse">CostByOrgResponse (class in datadog_api_client.v2.model.cost_by_org_response)</a>
@@ -14516,6 +14518,13 @@ <h2 id="D">D</h2>
1451614518

1451714519
<ul>
1451814520
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status">module</a>
14521+
</li>
14522+
</ul></li>
14523+
<li>
14524+
datadog_api_client.v2.model.case_status_group
14525+
14526+
<ul>
14527+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status_group">module</a>
1451914528
</li>
1452014529
</ul></li>
1452114530
<li>
@@ -47136,6 +47145,8 @@ <h2 id="M">M</h2>
4713647145
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_sortable_field">datadog_api_client.v2.model.case_sortable_field</a>
4713747146
</li>
4713847147
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status">datadog_api_client.v2.model.case_status</a>
47148+
</li>
47149+
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status_group">datadog_api_client.v2.model.case_status_group</a>
4713947150
</li>
4714047151
<li><a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_trigger">datadog_api_client.v2.model.case_trigger</a>
4714147152
</li>

objects.inv

17 Bytes
Binary file not shown.

py-modindex.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8567,6 +8567,11 @@ <h1>Python Module Index</h1>
85678567
<td>&#160;&#160;&#160;
85688568
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status"><code class="xref">datadog_api_client.v2.model.case_status</code></a></td><td>
85698569
<em></em></td></tr>
8570+
<tr class="cg-1">
8571+
<td></td>
8572+
<td>&#160;&#160;&#160;
8573+
<a href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.case_status_group"><code class="xref">datadog_api_client.v2.model.case_status_group</code></a></td><td>
8574+
<em></em></td></tr>
85708575
<tr class="cg-1">
85718576
<td></td>
85728577
<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)