Skip to content

Commit 7033743

Browse files
add On-Call Paging spec (#2551)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com> 3ed77f2
1 parent 31754cc commit 7033743

10 files changed

Lines changed: 654 additions & 11 deletions

_sources/datadog_api_client.v2.api.rst.txt

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -326,6 +326,13 @@ datadog\_api\_client.v2.api.on\_call\_api module
326326
:members:
327327
:show-inheritance:
328328

329+
datadog\_api\_client.v2.api.on\_call\_paging\_api module
330+
--------------------------------------------------------
331+
332+
.. automodule:: datadog_api_client.v2.api.on_call_paging_api
333+
:members:
334+
:show-inheritance:
335+
329336
datadog\_api\_client.v2.api.opsgenie\_integration\_api module
330337
-------------------------------------------------------------
331338

_sources/datadog_api_client.v2.model.rst.txt

Lines changed: 63 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3714,6 +3714,62 @@ datadog\_api\_client.v2.model.create\_open\_api\_response\_data module
37143714
:members:
37153715
:show-inheritance:
37163716

3717+
datadog\_api\_client.v2.model.create\_page\_request module
3718+
----------------------------------------------------------
3719+
3720+
.. automodule:: datadog_api_client.v2.model.create_page_request
3721+
:members:
3722+
:show-inheritance:
3723+
3724+
datadog\_api\_client.v2.model.create\_page\_request\_data module
3725+
----------------------------------------------------------------
3726+
3727+
.. automodule:: datadog_api_client.v2.model.create_page_request_data
3728+
:members:
3729+
:show-inheritance:
3730+
3731+
datadog\_api\_client.v2.model.create\_page\_request\_data\_attributes module
3732+
----------------------------------------------------------------------------
3733+
3734+
.. automodule:: datadog_api_client.v2.model.create_page_request_data_attributes
3735+
:members:
3736+
:show-inheritance:
3737+
3738+
datadog\_api\_client.v2.model.create\_page\_request\_data\_attributes\_target module
3739+
------------------------------------------------------------------------------------
3740+
3741+
.. automodule:: datadog_api_client.v2.model.create_page_request_data_attributes_target
3742+
:members:
3743+
:show-inheritance:
3744+
3745+
datadog\_api\_client.v2.model.create\_page\_request\_data\_type module
3746+
----------------------------------------------------------------------
3747+
3748+
.. automodule:: datadog_api_client.v2.model.create_page_request_data_type
3749+
:members:
3750+
:show-inheritance:
3751+
3752+
datadog\_api\_client.v2.model.create\_page\_response module
3753+
-----------------------------------------------------------
3754+
3755+
.. automodule:: datadog_api_client.v2.model.create_page_response
3756+
:members:
3757+
:show-inheritance:
3758+
3759+
datadog\_api\_client.v2.model.create\_page\_response\_data module
3760+
-----------------------------------------------------------------
3761+
3762+
.. automodule:: datadog_api_client.v2.model.create_page_response_data
3763+
:members:
3764+
:show-inheritance:
3765+
3766+
datadog\_api\_client.v2.model.create\_page\_response\_data\_type module
3767+
-----------------------------------------------------------------------
3768+
3769+
.. automodule:: datadog_api_client.v2.model.create_page_response_data_type
3770+
:members:
3771+
:show-inheritance:
3772+
37173773
datadog\_api\_client.v2.model.create\_rule\_request module
37183774
----------------------------------------------------------
37193775

@@ -11631,6 +11687,13 @@ datadog\_api\_client.v2.model.output\_schema\_parameters\_type module
1163111687
:members:
1163211688
:show-inheritance:
1163311689

11690+
datadog\_api\_client.v2.model.page\_urgency module
11691+
--------------------------------------------------
11692+
11693+
.. automodule:: datadog_api_client.v2.model.page_urgency
11694+
:members:
11695+
:show-inheritance:
11696+
1163411697
datadog\_api\_client.v2.model.pagination module
1163511698
-----------------------------------------------
1163611699

datadog_api_client.html

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2288,6 +2288,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
22882288
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.observability_pipelines_api">datadog_api_client.v2.api.observability_pipelines_api module</a></li>
22892289
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.okta_integration_api">datadog_api_client.v2.api.okta_integration_api module</a></li>
22902290
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.on_call_api">datadog_api_client.v2.api.on_call_api module</a></li>
2291+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.on_call_paging_api">datadog_api_client.v2.api.on_call_paging_api module</a></li>
22912292
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.opsgenie_integration_api">datadog_api_client.v2.api.opsgenie_integration_api module</a></li>
22922293
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.organizations_api">datadog_api_client.v2.api.organizations_api module</a></li>
22932294
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.api.html#module-datadog_api_client.v2.api.powerpack_api">datadog_api_client.v2.api.powerpack_api module</a></li>
@@ -2846,6 +2847,14 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
28462847
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_open_api_response">datadog_api_client.v2.model.create_open_api_response module</a></li>
28472848
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_open_api_response_attributes">datadog_api_client.v2.model.create_open_api_response_attributes module</a></li>
28482849
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_open_api_response_data">datadog_api_client.v2.model.create_open_api_response_data module</a></li>
2850+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_request">datadog_api_client.v2.model.create_page_request module</a></li>
2851+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_request_data">datadog_api_client.v2.model.create_page_request_data module</a></li>
2852+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_request_data_attributes">datadog_api_client.v2.model.create_page_request_data_attributes module</a></li>
2853+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_request_data_attributes_target">datadog_api_client.v2.model.create_page_request_data_attributes_target module</a></li>
2854+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_request_data_type">datadog_api_client.v2.model.create_page_request_data_type module</a></li>
2855+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_response">datadog_api_client.v2.model.create_page_response module</a></li>
2856+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_response_data">datadog_api_client.v2.model.create_page_response_data module</a></li>
2857+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_page_response_data_type">datadog_api_client.v2.model.create_page_response_data_type module</a></li>
28492858
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_rule_request">datadog_api_client.v2.model.create_rule_request module</a></li>
28502859
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_rule_request_data">datadog_api_client.v2.model.create_rule_request_data module</a></li>
28512860
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.create_rule_response">datadog_api_client.v2.model.create_rule_response module</a></li>
@@ -3977,6 +3986,7 @@ <h2 id="subpackages">Subpackages<a class="headerlink" href="#subpackages" title=
39773986
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.output_schema">datadog_api_client.v2.model.output_schema module</a></li>
39783987
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.output_schema_parameters">datadog_api_client.v2.model.output_schema_parameters module</a></li>
39793988
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.output_schema_parameters_type">datadog_api_client.v2.model.output_schema_parameters_type module</a></li>
3989+
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.page_urgency">datadog_api_client.v2.model.page_urgency module</a></li>
39803990
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.pagination">datadog_api_client.v2.model.pagination module</a></li>
39813991
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.parameter">datadog_api_client.v2.model.parameter module</a></li>
39823992
<li class="toctree-l4"><a class="reference internal" href="datadog_api_client.v2.model.html#module-datadog_api_client.v2.model.partial_api_key">datadog_api_client.v2.model.partial_api_key module</a></li>

datadog_api_client.v2.api.html

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1687,6 +1687,22 @@
16871687
</li></ul>
16881688
</nav>
16891689
</li>
1690+
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.on_call_paging_api" class="md-nav__link">datadog_api_client.v2.api.on_call_paging_api module</a><nav class="md-nav">
1691+
<ul class="md-nav__list">
1692+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallPagingApi</span></code></a><nav class="md-nav">
1693+
<ul class="md-nav__list">
1694+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.acknowledge_on_call_page" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallPagingApi.acknowledge_on_call_page()</span></code></a>
1695+
</li>
1696+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.create_on_call_page" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallPagingApi.create_on_call_page()</span></code></a>
1697+
</li>
1698+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.escalate_on_call_page" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallPagingApi.escalate_on_call_page()</span></code></a>
1699+
</li>
1700+
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.resolve_on_call_page" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OnCallPagingApi.resolve_on_call_page()</span></code></a>
1701+
</li></ul>
1702+
</nav>
1703+
</li></ul>
1704+
</nav>
1705+
</li>
16901706
<li class="md-nav__item"><a href="#module-datadog_api_client.v2.api.opsgenie_integration_api" class="md-nav__link">datadog_api_client.v2.api.opsgenie_integration_api module</a><nav class="md-nav">
16911707
<ul class="md-nav__list">
16921708
<li class="md-nav__item"><a href="#datadog_api_client.v2.api.opsgenie_integration_api.OpsgenieIntegrationApi" class="md-nav__link"><code class="docutils literal notranslate"><span class="pre">OpsgenieIntegrationApi</span></code></a><nav class="md-nav">
@@ -7780,6 +7796,69 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
77807796
</dd></dl>
77817797
</dd></dl>
77827798
</section>
7799+
<section id="module-datadog_api_client.v2.api.on_call_paging_api">
7800+
<span id="datadog-api-client-v2-api-on-call-paging-api-module"></span><h2 id="module-datadog_api_client.v2.api.on_call_paging_api">datadog_api_client.v2.api.on_call_paging_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.on_call_paging_api" title="Link to this heading">¶</a></h2>
7801+
<dl class="py class">
7802+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi">
7803+
<em class="property"><span class="pre">class</span><span class="w"> </span></em><span class="sig-name descname"><span class="pre">OnCallPagingApi</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">api_client</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="headerlink" href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi" title="Link to this definition">¶</a></dt>
7804+
<dd><p>Bases: <code class="xref py py-class docutils literal notranslate"><span class="pre">object</span></code></p>
7805+
<p>Trigger and manage <a class="reference external" href="https://docs.datadoghq.com/service_management/on-call/">Datadog On-Call</a>
7806+
pages directly through the Datadog API.</p>
7807+
<dl class="py method">
7808+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.acknowledge_on_call_page">
7809+
<span class="sig-name descname"><span class="pre">acknowledge_on_call_page</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">page_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">UUID</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.on_call_paging_api.OnCallPagingApi.acknowledge_on_call_page" title="Link to this definition">¶</a></dt>
7810+
<dd><p>Acknowledge On-Call Page.</p>
7811+
<p>Acknowledges an On-Call Page.</p>
7812+
<dl class="field-list simple">
7813+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7814+
<dd class="field-odd"><p><strong>page_id</strong> (<em>UUID</em>) – The page ID.</p>
7815+
</dd>
7816+
<dt class="field-even">Return type<span class="colon">:</span></dt>
7817+
<dd class="field-even"><p>None</p>
7818+
</dd>
7819+
</dl>
7820+
</dd></dl>
7821+
<dl class="py method">
7822+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.create_on_call_page">
7823+
<span class="sig-name descname"><span class="pre">create_on_call_page</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_page_request.CreatePageRequest" title="datadog_api_client.v2.model.create_page_request.CreatePageRequest"><span class="pre">CreatePageRequest</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.create_page_response.CreatePageResponse" title="datadog_api_client.v2.model.create_page_response.CreatePageResponse"><span class="pre">CreatePageResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.create_on_call_page" title="Link to this definition">¶</a></dt>
7824+
<dd><p>Create On-Call Page.</p>
7825+
<p>Trigger a new On-Call Page.</p>
7826+
<dl class="field-list simple">
7827+
<dt class="field-odd">Return type<span class="colon">:</span></dt>
7828+
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v2.model.html#datadog_api_client.v2.model.create_page_response.CreatePageResponse" title="datadog_api_client.v2.model.create_page_response.CreatePageResponse">CreatePageResponse</a></p>
7829+
</dd>
7830+
</dl>
7831+
</dd></dl>
7832+
<dl class="py method">
7833+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.escalate_on_call_page">
7834+
<span class="sig-name descname"><span class="pre">escalate_on_call_page</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">page_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">UUID</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.on_call_paging_api.OnCallPagingApi.escalate_on_call_page" title="Link to this definition">¶</a></dt>
7835+
<dd><p>Escalate On-Call Page.</p>
7836+
<p>Escalates an On-Call Page.</p>
7837+
<dl class="field-list simple">
7838+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7839+
<dd class="field-odd"><p><strong>page_id</strong> (<em>UUID</em>) – The page ID.</p>
7840+
</dd>
7841+
<dt class="field-even">Return type<span class="colon">:</span></dt>
7842+
<dd class="field-even"><p>None</p>
7843+
</dd>
7844+
</dl>
7845+
</dd></dl>
7846+
<dl class="py method">
7847+
<dt class="sig sig-object py" id="datadog_api_client.v2.api.on_call_paging_api.OnCallPagingApi.resolve_on_call_page">
7848+
<span class="sig-name descname"><span class="pre">resolve_on_call_page</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">page_id</span></span><span class="p"><span class="pre">:</span></span><span class="w"> </span><span class="n"><span class="pre">UUID</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.on_call_paging_api.OnCallPagingApi.resolve_on_call_page" title="Link to this definition">¶</a></dt>
7849+
<dd><p>Resolve On-Call Page.</p>
7850+
<p>Resolves an On-Call Page.</p>
7851+
<dl class="field-list simple">
7852+
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
7853+
<dd class="field-odd"><p><strong>page_id</strong> (<em>UUID</em>) – The page ID.</p>
7854+
</dd>
7855+
<dt class="field-even">Return type<span class="colon">:</span></dt>
7856+
<dd class="field-even"><p>None</p>
7857+
</dd>
7858+
</dl>
7859+
</dd></dl>
7860+
</dd></dl>
7861+
</section>
77837862
<section id="module-datadog_api_client.v2.api.opsgenie_integration_api">
77847863
<span id="datadog-api-client-v2-api-opsgenie-integration-api-module"></span><h2 id="module-datadog_api_client.v2.api.opsgenie_integration_api">datadog_api_client.v2.api.opsgenie_integration_api module<a class="headerlink" href="#module-datadog_api_client.v2.api.opsgenie_integration_api" title="Link to this heading">¶</a></h2>
77857864
<dl class="py class">

0 commit comments

Comments
 (0)