Skip to content

Commit a324f67

Browse files
Create OpenAPI for SLO status endpoint (#3093)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 4db84c2
1 parent 9af0894 commit a324f67

9 files changed

+316
-5
lines changed

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20087,6 +20087,13 @@ datadog\_api\_client.v2.model.query\_users\_request\_data\_type module
2008720087
:members:
2008820088
:show-inheritance:
2008920089

20090+
datadog\_api\_client.v2.model.raw\_error\_budget\_remaining module
20091+
------------------------------------------------------------------
20092+
20093+
.. automodule:: datadog_api_client.v2.model.raw_error_budget_remaining
20094+
:members:
20095+
:show-inheritance:
20096+
2009020097
datadog\_api\_client.v2.model.readiness\_gate module
2009120098
----------------------------------------------------
2009220099

@@ -25316,6 +25323,34 @@ datadog\_api\_client.v2.model.slo\_report\_status\_get\_response\_data module
2531625323
:members:
2531725324
:show-inheritance:
2531825325

25326+
datadog\_api\_client.v2.model.slo\_status\_data module
25327+
------------------------------------------------------
25328+
25329+
.. automodule:: datadog_api_client.v2.model.slo_status_data
25330+
:members:
25331+
:show-inheritance:
25332+
25333+
datadog\_api\_client.v2.model.slo\_status\_data\_attributes module
25334+
------------------------------------------------------------------
25335+
25336+
.. automodule:: datadog_api_client.v2.model.slo_status_data_attributes
25337+
:members:
25338+
:show-inheritance:
25339+
25340+
datadog\_api\_client.v2.model.slo\_status\_response module
25341+
----------------------------------------------------------
25342+
25343+
.. automodule:: datadog_api_client.v2.model.slo_status_response
25344+
:members:
25345+
:show-inheritance:
25346+
25347+
datadog\_api\_client.v2.model.slo\_status\_type module
25348+
------------------------------------------------------
25349+
25350+
.. automodule:: datadog_api_client.v2.model.slo_status_type
25351+
:members:
25352+
:show-inheritance:
25353+
2531925354
datadog\_api\_client.v2.model.software\_catalog\_trigger\_wrapper module
2532025355
------------------------------------------------------------------------
2532125356

datadog_api_client.html

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5432,6 +5432,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
54325432
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.query_users_request_data_attributes">datadog_api_client.v2.model.query_users_request_data_attributes module</a></li>
54335433
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.query_users_request_data_attributes_sort">datadog_api_client.v2.model.query_users_request_data_attributes_sort module</a></li>
54345434
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.query_users_request_data_type">datadog_api_client.v2.model.query_users_request_data_type module</a></li>
5435+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.raw_error_budget_remaining">datadog_api_client.v2.model.raw_error_budget_remaining module</a></li>
54355436
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.readiness_gate">datadog_api_client.v2.model.readiness_gate module</a></li>
54365437
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.readiness_gate_threshold_type">datadog_api_client.v2.model.readiness_gate_threshold_type module</a></li>
54375438
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.recommendation_attributes">datadog_api_client.v2.model.recommendation_attributes module</a></li>
@@ -6179,6 +6180,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
61796180
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_report_status_get_response">datadog_api_client.v2.model.slo_report_status_get_response module</a></li>
61806181
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_report_status_get_response_attributes">datadog_api_client.v2.model.slo_report_status_get_response_attributes module</a></li>
61816182
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_report_status_get_response_data">datadog_api_client.v2.model.slo_report_status_get_response_data module</a></li>
6183+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_data">datadog_api_client.v2.model.slo_status_data module</a></li>
6184+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_data_attributes">datadog_api_client.v2.model.slo_status_data_attributes module</a></li>
6185+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_response">datadog_api_client.v2.model.slo_status_response module</a></li>
6186+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_type">datadog_api_client.v2.model.slo_status_type module</a></li>
61826187
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.software_catalog_trigger_wrapper">datadog_api_client.v2.model.software_catalog_trigger_wrapper module</a></li>
61836188
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.sort_direction">datadog_api_client.v2.model.sort_direction module</a></li>
61846189
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.span">datadog_api_client.v2.model.span module</a></li>

datadog_api_client.v2.api.html

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2747,6 +2747,8 @@
27472747
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_report" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_report()</span></code></a>
27482748
</li>
27492749
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_report_job_status" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_report_job_status()</span></code></a>
2750+
</li>
2751+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_status" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_status()</span></code></a>
27502752
</li></ul>
27512753
</nav>
27522754
</li></ul>
@@ -15052,6 +15054,26 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
1505215054
</dd>
1505315055
</dl>
1505415056
</dd></dl>
15057+
<dl class="py method">
15058+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_status">
15059+
<span class="sig-name descname"><span class="pre">get_slo_status</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">slo_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">from_ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">to_ts</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">int</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">*</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">disable_corrections</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">bool</span><span class="w"> </span><span class="p"><span class="pre">|</span></span><span class="w"> </span><a class="reference internal" href="datadog_api_client.html#datadog_api_client.model_utils.UnsetType" title="datadog_api_client.model_utils.UnsetType"><span class="pre">UnsetType</span></a></span><span class="w"> </span><span class="o"><span class="pre">=</span></span><span class="w"> </span><span class="default_value"><span class="pre">UnsetType.unset</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.slo_status_response.SloStatusResponse" title="datadog_api_client.v2.model.slo_status_response.SloStatusResponse"><span class="pre">SloStatusResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_status" title="Link to this definition">¶</a></dt>
15060+
<dd><p>Get SLO status.</p>
15061+
<p>Get the status of a Service Level Objective (SLO) for a given time period.</p>
15062+
<p>This endpoint returns the current SLI value, error budget remaining, and other status information for the specified SLO.</p>
15063+
<dl class="field-list simple">
15064+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
15065+
<dd class="field-odd"><ul class="simple">
15066+
<li><p><strong>slo_id</strong> (<em>str</em>) – The ID of the SLO.</p></li>
15067+
<li><p><strong>from_ts</strong> (<em>int</em>) – The starting timestamp for the SLO status query in epoch seconds.</p></li>
15068+
<li><p><strong>to_ts</strong> (<em>int</em>) – The ending timestamp for the SLO status query in epoch seconds.</p></li>
15069+
<li><p><strong>disable_corrections</strong> (<em>bool</em><em>, </em><em>optional</em>) – Whether to exclude correction windows from the SLO status calculation. Defaults to false.</p></li>
15070+
</ul>
15071+
</dd>
15072+
<dt class="field-even">Return type<span class="colon">:</span></dt>
15073+
<dd class="field-even"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_status_response.SloStatusResponse" title="datadog_api_client.v2.model.slo_status_response.SloStatusResponse">SloStatusResponse</a></p>
15074+
</dd>
15075+
</dl>
15076+
</dd></dl>
1505515077
</dd></dl>
1505615078
</section>
1505715079
<section id="module-datadog_api_client.v2.api.service_now_integration_api">

datadog_api_client.v2.html

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2073,6 +2073,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
20732073
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.create_slo_report_job"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.create_slo_report_job()</span></code></a></li>
20742074
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_report"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_report()</span></code></a></li>
20752075
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_report_job_status"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_report_job_status()</span></code></a></li>
2076+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#datadog_api_client.v2.api.service_level_objectives_api.ServiceLevelObjectivesApi.get_slo_status"><code class="docutils literal notranslate"><span class="pre">ServiceLevelObjectivesApi.get_slo_status()</span></code></a></li>
20762077
</ul>
20772078
</li>
20782079
</ul>
@@ -13964,6 +13965,10 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
1396413965
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.query_users_request_data_type.QueryUsersRequestDataType"><code class="docutils literal notranslate"><span class="pre">QueryUsersRequestDataType</span></code></a></li>
1396513966
</ul>
1396613967
</li>
13968+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.raw_error_budget_remaining">datadog_api_client.v2.model.raw_error_budget_remaining module</a><ul>
13969+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.raw_error_budget_remaining.RawErrorBudgetRemaining"><code class="docutils literal notranslate"><span class="pre">RawErrorBudgetRemaining</span></code></a></li>
13970+
</ul>
13971+
</li>
1396713972
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.readiness_gate">datadog_api_client.v2.model.readiness_gate module</a><ul>
1396813973
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.readiness_gate.ReadinessGate"><code class="docutils literal notranslate"><span class="pre">ReadinessGate</span></code></a></li>
1396913974
</ul>
@@ -16952,6 +16957,22 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
1695216957
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_report_status_get_response_data.SLOReportStatusGetResponseData"><code class="docutils literal notranslate"><span class="pre">SLOReportStatusGetResponseData</span></code></a></li>
1695316958
</ul>
1695416959
</li>
16960+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_data">datadog_api_client.v2.model.slo_status_data module</a><ul>
16961+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_status_data.SloStatusData"><code class="docutils literal notranslate"><span class="pre">SloStatusData</span></code></a></li>
16962+
</ul>
16963+
</li>
16964+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_data_attributes">datadog_api_client.v2.model.slo_status_data_attributes module</a><ul>
16965+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_status_data_attributes.SloStatusDataAttributes"><code class="docutils literal notranslate"><span class="pre">SloStatusDataAttributes</span></code></a></li>
16966+
</ul>
16967+
</li>
16968+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_response">datadog_api_client.v2.model.slo_status_response module</a><ul>
16969+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_status_response.SloStatusResponse"><code class="docutils literal notranslate"><span class="pre">SloStatusResponse</span></code></a></li>
16970+
</ul>
16971+
</li>
16972+
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.slo_status_type">datadog_api_client.v2.model.slo_status_type module</a><ul>
16973+
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.slo_status_type.SloStatusType"><code class="docutils literal notranslate"><span class="pre">SloStatusType</span></code></a></li>
16974+
</ul>
16975+
</li>
1695516976
<li class="toctree-l2"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.software_catalog_trigger_wrapper">datadog_api_client.v2.model.software_catalog_trigger_wrapper module</a><ul>
1695616977
<li class="toctree-l3"><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.software_catalog_trigger_wrapper.SoftwareCatalogTriggerWrapper"><code class="docutils literal notranslate"><span class="pre">SoftwareCatalogTriggerWrapper</span></code></a></li>
1695716978
</ul>

0 commit comments

Comments
 (0)