Skip to content

Commit 8bbe060

Browse files
Update security finding triage specs (#3009)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 2b59847
1 parent e5437e0 commit 8bbe060

9 files changed

Lines changed: 45 additions & 254 deletions

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 0 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -5289,13 +5289,6 @@ datadog\_api\_client.v2.model.create\_jira\_issue\_request\_array module
52895289
:members:
52905290
:show-inheritance:
52915291

5292-
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_array\_included module
5293-
----------------------------------------------------------------------------------
5294-
5295-
.. automodule:: datadog_api_client.v2.model.create_jira_issue_request_array_included
5296-
:members:
5297-
:show-inheritance:
5298-
52995292
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data module
53005293
-----------------------------------------------------------------------
53015294

@@ -5310,34 +5303,13 @@ datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_attributes mod
53105303
:members:
53115304
:show-inheritance:
53125305

5313-
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_attributes\_fields module
5314-
-------------------------------------------------------------------------------------------
5315-
5316-
.. automodule:: datadog_api_client.v2.model.create_jira_issue_request_data_attributes_fields
5317-
:members:
5318-
:show-inheritance:
5319-
53205306
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships module
53215307
--------------------------------------------------------------------------------------
53225308

53235309
.. automodule:: datadog_api_client.v2.model.create_jira_issue_request_data_relationships
53245310
:members:
53255311
:show-inheritance:
53265312

5327-
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships\_case module
5328-
--------------------------------------------------------------------------------------------
5329-
5330-
.. automodule:: datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case
5331-
:members:
5332-
:show-inheritance:
5333-
5334-
datadog\_api\_client.v2.model.create\_jira\_issue\_request\_data\_relationships\_case\_data module
5335-
--------------------------------------------------------------------------------------------------
5336-
5337-
.. automodule:: datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case_data
5338-
:members:
5339-
:show-inheritance:
5340-
53415313
datadog\_api\_client.v2.model.create\_notification\_rule\_parameters module
53425314
---------------------------------------------------------------------------
53435315

datadog_api_client.html

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3291,13 +3291,9 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
32913291
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_incident_notification_rule_request">datadog_api_client.v2.model.create_incident_notification_rule_request module</a></li>
32923292
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_incident_notification_template_request">datadog_api_client.v2.model.create_incident_notification_template_request module</a></li>
32933293
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_array">datadog_api_client.v2.model.create_jira_issue_request_array module</a></li>
3294-
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_array_included">datadog_api_client.v2.model.create_jira_issue_request_array_included module</a></li>
32953294
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data">datadog_api_client.v2.model.create_jira_issue_request_data module</a></li>
32963295
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data_attributes">datadog_api_client.v2.model.create_jira_issue_request_data_attributes module</a></li>
3297-
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data_attributes_fields">datadog_api_client.v2.model.create_jira_issue_request_data_attributes_fields module</a></li>
32983296
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data_relationships">datadog_api_client.v2.model.create_jira_issue_request_data_relationships module</a></li>
3299-
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case">datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case module</a></li>
3300-
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case_data">datadog_api_client.v2.model.create_jira_issue_request_data_relationships_case_data module</a></li>
33013297
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_notification_rule_parameters">datadog_api_client.v2.model.create_notification_rule_parameters module</a></li>
33023298
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_notification_rule_parameters_data">datadog_api_client.v2.model.create_notification_rule_parameters_data module</a></li>
33033299
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_notification_rule_parameters_data_attributes">datadog_api_client.v2.model.create_notification_rule_parameters_data_attributes module</a></li>

datadog_api_client.v2.api.html

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -12196,10 +12196,11 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1219612196
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.attach_case">
1219712197
<span class="sig-name descname"><span class="pre">attach_case</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.attach_case_request.AttachCaseRequest" title="datadog_api_client.v2.model.attach_case_request.AttachCaseRequest"><span class="pre">AttachCaseRequest</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.finding_case_response.FindingCaseResponse" title="datadog_api_client.v2.model.finding_case_response.FindingCaseResponse"><span class="pre">FindingCaseResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.attach_case" title="Link to this definition">¶</a></dt>
1219812198
<dd><p>Attach security findings to a case.</p>
12199-
<p>Attach security findings to a case. You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.</p>
12199+
<p>Attach security findings to a case.
12200+
You can attach up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the specified case.</p>
1220012201
<dl class="field-list simple">
1220112202
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
12202-
<dd class="field-odd"><p><strong>case_id</strong> (<em>str</em>) – The unique identifier of the case to attach security findings to</p>
12203+
<dd class="field-odd"><p><strong>case_id</strong> (<em>str</em>) – Unique identifier of the case to attach security findings to</p>
1220312204
</dd>
1220412205
<dt class="field-even">Return type<span class="colon">:</span></dt>
1220512206
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.finding_case_response.FindingCaseResponse" title="datadog_api_client.v2.model.finding_case_response.FindingCaseResponse">FindingCaseResponse</a></p>
@@ -12210,7 +12211,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1221012211
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.attach_jira_issue">
1221112212
<span class="sig-name descname"><span class="pre">attach_jira_issue</span></span><span class="sig-paren">(</span><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.attach_jira_issue_request.AttachJiraIssueRequest" title="datadog_api_client.v2.model.attach_jira_issue_request.AttachJiraIssueRequest"><span class="pre">AttachJiraIssueRequest</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.finding_case_response.FindingCaseResponse" title="datadog_api_client.v2.model.finding_case_response.FindingCaseResponse"><span class="pre">FindingCaseResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.attach_jira_issue" title="Link to this definition">¶</a></dt>
1221212213
<dd><p>Attach security findings to a Jira issue.</p>
12213-
<p>Attach security findings to a Jira issue by providing the Jira issue URL. You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.</p>
12214+
<p>Attach security findings to a Jira issue by providing the Jira issue URL.
12215+
You can attach up to 50 security findings per Jira issue. If the Jira issue is not linked to any case, this operation will create a case for the security findings and link the Jira issue to the newly created case. To configure the Jira integration, see <a class="reference external" href="https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira">Bidirectional ticket syncing with Jira</a>. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the specified Jira issue.</p>
1221412216
<dl class="field-list simple">
1221512217
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1221612218
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.finding_case_response.FindingCaseResponse" title="datadog_api_client.v2.model.finding_case_response.FindingCaseResponse">FindingCaseResponse</a></p>
@@ -12285,7 +12287,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1228512287
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.create_cases">
1228612288
<span class="sig-name descname"><span class="pre">create_cases</span></span><span class="sig-paren">(</span><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.create_case_request_array.CreateCaseRequestArray" title="datadog_api_client.v2.model.create_case_request_array.CreateCaseRequestArray"><span class="pre">CreateCaseRequestArray</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.finding_case_response_array.FindingCaseResponseArray" title="datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray"><span class="pre">FindingCaseResponseArray</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.create_cases" title="Link to this definition">¶</a></dt>
1228712289
<dd><p>Create cases for security findings.</p>
12288-
<p>Create cases for security findings. You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.</p>
12290+
<p>Create cases for security findings.
12291+
You can create up to 50 cases per request and associate up to 50 security findings per case. Security findings that are already attached to another case will be detached from their previous case and attached to the newly created case.</p>
1228912292
<dl class="field-list simple">
1229012293
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1229112294
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray" title="datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray">FindingCaseResponseArray</a></p>
@@ -12307,7 +12310,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1230712310
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.create_jira_issues">
1230812311
<span class="sig-name descname"><span class="pre">create_jira_issues</span></span><span class="sig-paren">(</span><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.create_jira_issue_request_array.CreateJiraIssueRequestArray" title="datadog_api_client.v2.model.create_jira_issue_request_array.CreateJiraIssueRequestArray"><span class="pre">CreateJiraIssueRequestArray</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.finding_case_response_array.FindingCaseResponseArray" title="datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray"><span class="pre">FindingCaseResponseArray</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.create_jira_issues" title="Link to this definition">¶</a></dt>
1230912312
<dd><p>Create Jira issues for security findings.</p>
12310-
<p>Create Jira issues for security findings. This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.</p>
12313+
<p>Create Jira issues for security findings.
12314+
This operation creates a case in Datadog and a Jira issue linked to that case for bidirectional sync between Datadog and Jira. To configure the Jira integration, see <a class="reference external" href="https://docs.datadoghq.com/security/ticketing_integrations/#bidirectional-ticket-syncing-with-jira">Bidirectional ticket syncing with Jira</a>. You can create up to 50 Jira issues per request and associate up to 50 security findings per Jira issue. Security findings that are already attached to another Jira issue will be detached from their previous Jira issue and attached to the newly created Jira issue.</p>
1231112315
<dl class="field-list simple">
1231212316
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1231312317
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray" title="datadog_api_client.v2.model.finding_case_response_array.FindingCaseResponseArray">FindingCaseResponseArray</a></p>
@@ -12490,7 +12494,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1249012494
<dt class="sig sig-object py" id="datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.detach_case">
1249112495
<span class="sig-name descname"><span class="pre">detach_case</span></span><span class="sig-paren">(</span><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.detach_case_request.DetachCaseRequest" title="datadog_api_client.v2.model.detach_case_request.DetachCaseRequest"><span class="pre">DetachCaseRequest</span></a></span></em><span class="sig-paren">)</span> <span class="sig-return"><span class="sig-return-icon">→</span> <span class="sig-return-typehint"><span class="pre">None</span></span></span><a class="headerlink" href="#datadog_api_client.v2.api.security_monitoring_api.SecurityMonitoringApi.detach_case" title="Link to this definition">¶</a></dt>
1249212496
<dd><p>Detach security findings from their case.</p>
12493-
<p>Detach security findings from their case. This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.</p>
12497+
<p>Detach security findings from their case.
12498+
This operation dissociates security findings from their associated cases without deleting the cases themselves. You can detach security findings from multiple different cases in a single request, with a limit of 50 security findings per request. Security findings that are not currently attached to any case will be ignored.</p>
1249412499
<dl class="field-list simple">
1249512500
<dt class="field-odd">Return type<span class="colon">:</span></dt>
1249612501
<dd class="field-odd"><p>None</p>

0 commit comments

Comments
 (0)