Skip to content

Commit 5dab299

Browse files
[SDCD-1826] Update DORA endpoints description and name (#2873)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> bea00be
1 parent c07a8b1 commit 5dab299

2 files changed

Lines changed: 7 additions & 7 deletions

File tree

datadog_api_client.v2.api.html

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5828,8 +5828,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
58285828
<dl class="py method">
58295829
<dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_deployment">
58305830
<span class="sig-name descname"><span class="pre">create_dora_deployment</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_deployment_request.DORADeploymentRequest" title="datadog_api_client.v2.model.dora_deployment_request.DORADeploymentRequest"><span class="pre">DORADeploymentRequest</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_deployment_response.DORADeploymentResponse" title="datadog_api_client.v2.model.dora_deployment_response.DORADeploymentResponse"><span class="pre">DORADeploymentResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_deployment" title="Link to this definition">¶</a></dt>
5831-
<dd><p>Send a deployment event for DORA Metrics.</p>
5832-
<p>Use this API endpoint to provide data about deployments for DORA metrics.</p>
5831+
<dd><p>Send a deployment event.</p>
5832+
<p>Use this API endpoint to provide deployment data.</p>
58335833
<p>This is necessary for:</p>
58345834
<ul class="simple">
58355835
<li><p>Deployment Frequency</p></li>
@@ -5845,8 +5845,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
58455845
<dl class="py method">
58465846
<dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_failure">
58475847
<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>
5848-
<dd><p>Send a failure event for DORA Metrics.</p>
5849-
<p>Use this API endpoint to provide failure data for DORA metrics.</p>
5848+
<dd><p>Send a failure event.</p>
5849+
<p>Use this API endpoint to provide failure data.</p>
58505850
<p>This is necessary for:</p>
58515851
<ul class="simple">
58525852
<li><p>Change Failure Rate</p></li>
@@ -5861,9 +5861,9 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
58615861
<dl class="py method">
58625862
<dt class="sig sig-object py" id="datadog_api_client.v2.api.dora_metrics_api.DORAMetricsApi.create_dora_incident">
58635863
<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>
5864-
<dd><p>Send an incident event for DORA Metrics. <strong>Deprecated</strong>.</p>
5864+
<dd><p>Send an incident event. <strong>Deprecated</strong>.</p>
58655865
<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>
5866-
<p>Use this API endpoint to provide failure data for DORA metrics.</p>
5866+
<p>Use this API endpoint to provide failure data.</p>
58675867
<p>This is necessary for:</p>
58685868
<ul class="simple">
58695869
<li><p>Change Failure Rate</p></li>

datadog_api_client.v2.model.html

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40687,7 +40687,7 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
4068740687
<dd class="field-odd"><ul class="simple">
4068840688
<li><p><strong>custom_tags</strong> (<em>[</em><em>str</em><em>]</em><em>, </em><em>none_type</em><em>, </em><em>optional</em>) – A list of user-defined tags. The tags must follow the <code class="docutils literal notranslate"><span class="pre">key:value</span></code> pattern. Up to 100 may be added per event.</p></li>
4068940689
<li><p><strong>env</strong> (<em>str</em><em>, </em><em>optional</em>) – Environment name to where the service was deployed.</p></li>
40690-
<li><p><strong>finished_at</strong> (<em>int</em>) – Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds, and it should not be older than 1 hour.</p></li>
40690+
<li><p><strong>finished_at</strong> (<em>int</em>) – Unix timestamp when the deployment finished. It must be in nanoseconds, milliseconds, or seconds.</p></li>
4069140691
<li><p><strong>git</strong> (<a class="reference internal" href="#datadog_api_client.v2.model.dora_git_info.DORAGitInfo" title="datadog_api_client.v2.model.dora_git_info.DORAGitInfo"><em>DORAGitInfo</em></a><em>, </em><em>optional</em>) – Git info for DORA Metrics events.</p></li>
4069240692
<li><p><strong>id</strong> (<em>str</em><em>, </em><em>optional</em>) – Deployment ID.</p></li>
4069340693
<li><p><strong>service</strong> (<em>str</em>) – Service name.</p></li>

0 commit comments

Comments
 (0)