Skip to content

Commit 1b34e77

Browse files
Update descriptions for otr mode (#2941)
Co-authored-by: ci.datadog-api-spec <[email protected]> f433790
1 parent 213f06b commit 1b34e77

File tree

3 files changed

+15
-8
lines changed

3 files changed

+15
-8
lines changed

datadog_api_client.v1.api.html

Lines changed: 10 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2651,7 +2651,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
26512651
<dt class="sig sig-object py" id="datadog_api_client.v1.api.key_management_api.KeyManagementApi.create_application_key">
26522652
<span class="sig-name descname"><span class="pre">create_application_key</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.v1.model.html#datadog_api_client.v1.model.application_key.ApplicationKey" title="datadog_api_client.v1.model.application_key.ApplicationKey"><span class="pre">ApplicationKey</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.v1.model.html#datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.key_management_api.KeyManagementApi.create_application_key" title="Link to this definition">¶</a></dt>
26532653
<dd><p>Create an application key.</p>
2654-
<p>Create an application key with a given name.</p>
2654+
<p>Create an application key with a given name.
2655+
This endpoint is disabled for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
26552656
<dl class="field-list simple">
26562657
<dt class="field-odd">Return type<span class="colon">:</span></dt>
26572658
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse">ApplicationKeyResponse</a></p>
@@ -2676,7 +2677,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
26762677
<dt class="sig sig-object py" id="datadog_api_client.v1.api.key_management_api.KeyManagementApi.delete_application_key">
26772678
<span class="sig-name descname"><span class="pre">delete_application_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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.v1.model.html#datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.key_management_api.KeyManagementApi.delete_application_key" title="Link to this definition">¶</a></dt>
26782679
<dd><p>Delete an application key.</p>
2679-
<p>Delete a given application key.</p>
2680+
<p>Delete a given application key.
2681+
This endpoint is disabled for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
26802682
<dl class="field-list simple">
26812683
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
26822684
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – The specific APP key you are working with.</p>
@@ -2704,7 +2706,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
27042706
<dt class="sig sig-object py" id="datadog_api_client.v1.api.key_management_api.KeyManagementApi.get_application_key">
27052707
<span class="sig-name descname"><span class="pre">get_application_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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.v1.model.html#datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.key_management_api.KeyManagementApi.get_application_key" title="Link to this definition">¶</a></dt>
27062708
<dd><p>Get an application key.</p>
2707-
<p>Get a given application key.</p>
2709+
<p>Get a given application key.
2710+
This endpoint is disabled for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
27082711
<dl class="field-list simple">
27092712
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
27102713
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – The specific APP key you are working with.</p>
@@ -2729,7 +2732,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
27292732
<dt class="sig sig-object py" id="datadog_api_client.v1.api.key_management_api.KeyManagementApi.list_application_keys">
27302733
<span class="sig-name descname"><span class="pre">list_application_keys</span></span><span class="sig-paren">(</span><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.v1.model.html#datadog_api_client.v1.model.application_key_list_response.ApplicationKeyListResponse" title="datadog_api_client.v1.model.application_key_list_response.ApplicationKeyListResponse"><span class="pre">ApplicationKeyListResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.key_management_api.KeyManagementApi.list_application_keys" title="Link to this definition">¶</a></dt>
27312734
<dd><p>Get all application keys.</p>
2732-
<p>Get all application keys available for your Datadog account.</p>
2735+
<p>Get all application keys available for your Datadog account.
2736+
This endpoint is disabled for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
27332737
<dl class="field-list simple">
27342738
<dt class="field-odd">Return type<span class="colon">:</span></dt>
27352739
<dd class="field-odd"><p><a class="reference internal" href="datadog_api_client.v1.model.html#datadog_api_client.v1.model.application_key_list_response.ApplicationKeyListResponse" title="datadog_api_client.v1.model.application_key_list_response.ApplicationKeyListResponse">ApplicationKeyListResponse</a></p>
@@ -2754,7 +2758,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
27542758
<dt class="sig sig-object py" id="datadog_api_client.v1.api.key_management_api.KeyManagementApi.update_application_key">
27552759
<span class="sig-name descname"><span class="pre">update_application_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">key</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.v1.model.html#datadog_api_client.v1.model.application_key.ApplicationKey" title="datadog_api_client.v1.model.application_key.ApplicationKey"><span class="pre">ApplicationKey</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.v1.model.html#datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v1.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v1.api.key_management_api.KeyManagementApi.update_application_key" title="Link to this definition">¶</a></dt>
27562760
<dd><p>Edit an application key.</p>
2757-
<p>Edit an application key name.</p>
2761+
<p>Edit an application key name.
2762+
This endpoint is disabled for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
27582763
<dl class="field-list simple">
27592764
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
27602765
<dd class="field-odd"><p><strong>key</strong> (<em>str</em>) – The specific APP key you are working with.</p>

datadog_api_client.v2.api.html

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8416,7 +8416,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
84168416
<dt class="sig sig-object py" id="datadog_api_client.v2.api.key_management_api.KeyManagementApi.get_current_user_application_key">
84178417
<span class="sig-name descname"><span class="pre">get_current_user_application_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app_key_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.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v2.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.key_management_api.KeyManagementApi.get_current_user_application_key" title="Link to this definition">¶</a></dt>
84188418
<dd><p>Get one application key owned by current user.</p>
8419-
<p>Get an application key owned by current user</p>
8419+
<p>Get an application key owned by current user.
8420+
The <code class="docutils literal notranslate"><span class="pre">key</span></code> field is not returned for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
84208421
<dl class="field-list simple">
84218422
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
84228423
<dd class="field-odd"><p><strong>app_key_id</strong> (<em>str</em>) – The ID of the application key.</p>
@@ -8534,7 +8535,8 @@ <h2 id="submodules">Submodules<a class="headerlink" href="#submodules" title="Li
85348535
<dt class="sig sig-object py" id="datadog_api_client.v2.api.key_management_api.KeyManagementApi.update_current_user_application_key">
85358536
<span class="sig-name descname"><span class="pre">update_current_user_application_key</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">app_key_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.application_key_update_request.ApplicationKeyUpdateRequest" title="datadog_api_client.v2.model.application_key_update_request.ApplicationKeyUpdateRequest"><span class="pre">ApplicationKeyUpdateRequest</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.application_key_response.ApplicationKeyResponse" title="datadog_api_client.v2.model.application_key_response.ApplicationKeyResponse"><span class="pre">ApplicationKeyResponse</span></a></span></span><a class="headerlink" href="#datadog_api_client.v2.api.key_management_api.KeyManagementApi.update_current_user_application_key" title="Link to this definition">¶</a></dt>
85368537
<dd><p>Edit an application key owned by current user.</p>
8537-
<p>Edit an application key owned by current user</p>
8538+
<p>Edit an application key owned by current user.
8539+
The <code class="docutils literal notranslate"><span class="pre">key</span></code> field is not returned for organizations in <a class="reference external" href="https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode">One-Time Read mode</a>.</p>
85388540
<dl class="field-list simple">
85398541
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
85408542
<dd class="field-odd"><p><strong>app_key_id</strong> (<em>str</em>) – The ID of the application key.</p>

searchindex.js

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)