DORA Metrics - Change failure detection, follow-ups (#3171)

Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> a8a6afe

Author: api-clients-generation-pipeline[bot]

datadog_api_client.v2.api.html

@@ -7510,6 +7510,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <li><p>Deployment Frequency</p></li>
 <li><p>Change Lead Time</p></li>
 <li><p>Change Failure Rate</p></li>
+<li><p>Failed Deployment Recovery Time</p></li>
 </ul>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
@@ -7520,13 +7521,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_failure">
 <span class="sig-name descname"><span class="pre">create_dora_failure</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.dora_failure_request.DORAFailureRequest" title="datadog_api_client.v2.model.dora_failure_request.DORAFailureRequest"><span class="pre">DORAFailureRequest</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.dora_failure_response.DORAFailureResponse" title="datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse"><span class="pre">DORAFailureResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_failure" title="Link to this definition">¶</a></dt>
-<dd><p>Send a failure event.</p>
-<p>Use this API endpoint to provide failure data.</p>
-<p>This is necessary for:</p>
-<ul class="simple">
-<li><p>Change Failure Rate</p></li>
-<li><p>Time to Restore</p></li>
-</ul>
+<dd><p>Send an incident event.</p>
+<p>Use this API endpoint to provide incident data for DORA Metrics.
+Note that change failure rate and failed deployment recovery time are computed from change failures detected on deployments, not from incident events sent through this endpoint.
+Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents, including their severity and frequency.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse" title="datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse">DORAFailureResponse</a></p>
@@ -7536,14 +7534,10 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_incident">
 <span class="sig-name descname"><span class="pre">create_dora_incident</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.dora_failure_request.DORAFailureRequest" title="datadog_api_client.v2.model.dora_failure_request.DORAFailureRequest"><span class="pre">DORAFailureRequest</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.dora_failure_response.DORAFailureResponse" title="datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse"><span class="pre">DORAFailureResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_incident" title="Link to this definition">¶</a></dt>
-<dd><p>Send an incident event. <strong>Deprecated</strong>.</p>
+<dd><p>Send an incident event (legacy). <strong>Deprecated</strong>.</p>
 <p><strong>Note</strong> : This endpoint is deprecated. Please use <code class="docutils literal notranslate"><span class="pre">/api/v2/dora/failure</span></code> instead.</p>
-<p>Use this API endpoint to provide failure data.</p>
-<p>This is necessary for:</p>
-<ul class="simple">
-<li><p>Change Failure Rate</p></li>
-<li><p>Time to Restore</p></li>
-</ul>
+<p>Use this API endpoint to provide incident data.
+Tracking incidents gives a side-by-side view of how failed deployments translate into real-world incidents.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse" title="datadog_api_client.v2.model.dora_failure_response.DORAFailureResponse">DORAFailureResponse</a></p>
@@ -7567,11 +7561,11 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.delete_dora_failure">
 <span class="sig-name descname"><span class="pre">delete_dora_failure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_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><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.dora_metrics_api.DORAMetricsApi.delete_dora_failure" title="Link to this definition">¶</a></dt>
-<dd><p>Delete a failure event.</p>
-<p>Use this API endpoint to delete a failure event.</p>
+<dd><p>Delete an incident event.</p>
+<p>Use this API endpoint to delete an incident event.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>failure_id</strong> (<em>str</em>) – The ID of the failure event to delete.</p>
+<dd class="field-odd"><p><strong>failure_id</strong> (<em>str</em>) – The ID of the incident event to delete.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p>None</p>
@@ -7595,11 +7589,11 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.get_dora_failure">
 <span class="sig-name descname"><span class="pre">get_dora_failure</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">failure_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><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.dora_failure_fetch_response.DORAFailureFetchResponse" title="datadog_api_client.v2.model.dora_failure_fetch_response.DORAFailureFetchResponse"><span class="pre">DORAFailureFetchResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.get_dora_failure" title="Link to this definition">¶</a></dt>
-<dd><p>Get a failure event.</p>
-<p>Use this API endpoint to get a failure event.</p>
+<dd><p>Get an incident event.</p>
+<p>Use this API endpoint to get an incident event.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
-<dd class="field-odd"><p><strong>failure_id</strong> (<em>str</em>) – The ID of the failure event.</p>
+<dd class="field-odd"><p><strong>failure_id</strong> (<em>str</em>) – The ID of the incident event.</p>
 </dd>
 <dt class="field-even">Return type<span class="colon">:</span></dt>
 <dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dora_failure_fetch_response.DORAFailureFetchResponse" title="datadog_api_client.v2.model.dora_failure_fetch_response.DORAFailureFetchResponse">DORAFailureFetchResponse</a></p>
@@ -7620,8 +7614,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dl class="py method">
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.list_dora_failures">
 <span class="sig-name descname"><span class="pre">list_dora_failures</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.dora_list_failures_request.DORAListFailuresRequest" title="datadog_api_client.v2.model.dora_list_failures_request.DORAListFailuresRequest"><span class="pre">DORAListFailuresRequest</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.dora_failures_list_response.DORAFailuresListResponse" title="datadog_api_client.v2.model.dora_failures_list_response.DORAFailuresListResponse"><span class="pre">DORAFailuresListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.list_dora_failures" title="Link to this definition">¶</a></dt>
-<dd><p>Get a list of failure events.</p>
-<p>Use this API endpoint to get a list of failure events.</p>
+<dd><p>Get a list of incident events.</p>
+<p>Use this API endpoint to get a list of incident events.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Return type<span class="colon">:</span></dt>
 <dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.dora_failures_list_response.DORAFailuresListResponse" title="datadog_api_client.v2.model.dora_failures_list_response.DORAFailuresListResponse">DORAFailuresListResponse</a></p>
@@ -7632,7 +7626,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
 <dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.patch_dora_deployment">
 <span class="sig-name descname"><span class="pre">patch_dora_deployment</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">deployment_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.dora_deployment_patch_request.DORADeploymentPatchRequest" title="datadog_api_client.v2.model.dora_deployment_patch_request.DORADeploymentPatchRequest"><span class="pre">DORADeploymentPatchRequest</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.dora_metrics_api.DORAMetricsApi.patch_dora_deployment" title="Link to this definition">¶</a></dt>
 <dd><p>Patch a deployment event.</p>
-<p>Use this API endpoint to patch a deployment event.</p>
+<p>Update a deployment’s change failure status. Use this to mark a deployment as a change failure or back to stable. You can optionally include remediation details to enable failed deployment recovery time calculation.</p>
 <dl class="field-list simple">
 <dt class="field-odd">Parameters<span class="colon">:</span></dt>
 <dd class="field-odd"><p><strong>deployment_id</strong> (<em>str</em>) – The ID of the deployment event.</p>