Skip to content

Commit dd06bf3

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
Update descriptions for otr mode (#2770)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 0f05c18 commit dd06bf3

File tree

4 files changed

+30
-9
lines changed

4 files changed

+30
-9
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -25843,7 +25843,9 @@ paths:
2584325843
- api_keys_write
2584425844
/api/v1/application_key:
2584525845
get:
25846-
description: Get all application keys available for your Datadog account.
25846+
description: 'Get all application keys available for your Datadog account.
25847+
25848+
This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
2584725849
operationId: ListApplicationKeys
2584825850
responses:
2584925851
'200':
@@ -25869,7 +25871,9 @@ paths:
2586925871
- org_app_keys_read
2587025872
- user_app_keys
2587125873
post:
25872-
description: Create an application key with a given name.
25874+
description: 'Create an application key with a given name.
25875+
25876+
This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
2587325877
operationId: CreateApplicationKey
2587425878
requestBody:
2587525879
content:
@@ -25914,7 +25918,9 @@ paths:
2591425918
- user_app_keys
2591525919
/api/v1/application_key/{key}:
2591625920
delete:
25917-
description: Delete a given application key.
25921+
description: 'Delete a given application key.
25922+
25923+
This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
2591825924
operationId: DeleteApplicationKey
2591925925
parameters:
2592025926
- description: The specific APP key you are working with.
@@ -25953,7 +25959,9 @@ paths:
2595325959
- org_app_keys_write
2595425960
- user_app_keys
2595525961
get:
25956-
description: Get a given application key.
25962+
description: 'Get a given application key.
25963+
25964+
This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
2595725965
operationId: GetApplicationKey
2595825966
parameters:
2595925967
- description: The specific APP key you are working with.
@@ -25992,7 +26000,9 @@ paths:
2599226000
- org_app_keys_read
2599326001
- user_app_keys
2599426002
put:
25995-
description: Edit an application key name.
26003+
description: 'Edit an application key name.
26004+
26005+
This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
2599626006
operationId: UpdateApplicationKey
2599726007
parameters:
2599826008
- description: The specific APP key you are working with.

.generator/schemas/v2/openapi.yaml

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -62965,7 +62965,9 @@ paths:
6296562965
permissions:
6296662966
- user_app_keys
6296762967
get:
62968-
description: Get an application key owned by current user
62968+
description: 'Get an application key owned by current user.
62969+
62970+
The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
6296962971
operationId: GetCurrentUserApplicationKey
6297062972
parameters:
6297162973
- $ref: '#/components/parameters/ApplicationKeyID'
@@ -62998,7 +63000,9 @@ paths:
6299863000
permissions:
6299963001
- user_app_keys
6300063002
patch:
63001-
description: Edit an application key owned by current user
63003+
description: 'Edit an application key owned by current user.
63004+
63005+
The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).'
6300263006
operationId: UpdateCurrentUserApplicationKey
6300363007
parameters:
6300463008
- $ref: '#/components/parameters/ApplicationKeyID'

lib/datadog_api_client/v1/api/key_management_api.rb

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,7 @@ def create_application_key(body, opts = {})
101101
# Create an application key.
102102
#
103103
# Create an application key with a given name.
104+
# This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
104105
#
105106
# @param body [ApplicationKey]
106107
# @param opts [Hash] the optional parameters
@@ -233,6 +234,7 @@ def delete_application_key(key, opts = {})
233234
# Delete an application key.
234235
#
235236
# Delete a given application key.
237+
# This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
236238
#
237239
# @param key [String] The specific APP key you are working with.
238240
# @param opts [Hash] the optional parameters
@@ -363,6 +365,7 @@ def get_application_key(key, opts = {})
363365
# Get an application key.
364366
#
365367
# Get a given application key.
368+
# This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
366369
#
367370
# @param key [String] The specific APP key you are working with.
368371
# @param opts [Hash] the optional parameters
@@ -488,6 +491,7 @@ def list_application_keys(opts = {})
488491
# Get all application keys.
489492
#
490493
# Get all application keys available for your Datadog account.
494+
# This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
491495
#
492496
# @param opts [Hash] the optional parameters
493497
# @return [Array<(ApplicationKeyListResponse, Integer, Hash)>] ApplicationKeyListResponse data, response status code and response headers
@@ -620,6 +624,7 @@ def update_application_key(key, body, opts = {})
620624
# Edit an application key.
621625
#
622626
# Edit an application key name.
627+
# This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
623628
#
624629
# @param key [String] The specific APP key you are working with.
625630
# @param body [ApplicationKey]

lib/datadog_api_client/v2/api/key_management_api.rb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -496,7 +496,8 @@ def get_current_user_application_key(app_key_id, opts = {})
496496

497497
# Get one application key owned by current user.
498498
#
499-
# Get an application key owned by current user
499+
# Get an application key owned by current user.
500+
# The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
500501
#
501502
# @param app_key_id [String] The ID of the application key.
502503
# @param opts [Hash] the optional parameters
@@ -947,7 +948,8 @@ def update_current_user_application_key(app_key_id, body, opts = {})
947948

948949
# Edit an application key owned by current user.
949950
#
950-
# Edit an application key owned by current user
951+
# Edit an application key owned by current user.
952+
# The `key` field is not returned for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
951953
#
952954
# @param app_key_id [String] The ID of the application key.
953955
# @param body [ApplicationKeyUpdateRequest]

0 commit comments

Comments
 (0)