Skip to content

Commit 7d280a7

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

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'

api/datadogV1/api_key_management.go

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -97,6 +97,7 @@ func (a *KeyManagementApi) CreateAPIKey(ctx _context.Context, body ApiKey) (ApiK
9797

9898
// CreateApplicationKey Create an application key.
9999
// Create an application key with a given name.
100+
// This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
100101
func (a *KeyManagementApi) CreateApplicationKey(ctx _context.Context, body ApplicationKey) (ApplicationKeyResponse, *_nethttp.Response, error) {
101102
var (
102103
localVarHTTPMethod = _nethttp.MethodPost
@@ -255,6 +256,7 @@ func (a *KeyManagementApi) DeleteAPIKey(ctx _context.Context, key string) (ApiKe
255256

256257
// DeleteApplicationKey Delete an application key.
257258
// Delete a given application key.
259+
// This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
258260
func (a *KeyManagementApi) DeleteApplicationKey(ctx _context.Context, key string) (ApplicationKeyResponse, *_nethttp.Response, error) {
259261
var (
260262
localVarHTTPMethod = _nethttp.MethodDelete
@@ -411,6 +413,7 @@ func (a *KeyManagementApi) GetAPIKey(ctx _context.Context, key string) (ApiKeyRe
411413

412414
// GetApplicationKey Get an application key.
413415
// Get a given application key.
416+
// This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
414417
func (a *KeyManagementApi) GetApplicationKey(ctx _context.Context, key string) (ApplicationKeyResponse, *_nethttp.Response, error) {
415418
var (
416419
localVarHTTPMethod = _nethttp.MethodGet
@@ -566,6 +569,7 @@ func (a *KeyManagementApi) ListAPIKeys(ctx _context.Context) (ApiKeyListResponse
566569

567570
// ListApplicationKeys Get all application keys.
568571
// Get all application keys available for your Datadog account.
572+
// This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
569573
func (a *KeyManagementApi) ListApplicationKeys(ctx _context.Context) (ApplicationKeyListResponse, *_nethttp.Response, error) {
570574
var (
571575
localVarHTTPMethod = _nethttp.MethodGet
@@ -724,6 +728,7 @@ func (a *KeyManagementApi) UpdateAPIKey(ctx _context.Context, key string, body A
724728

725729
// UpdateApplicationKey Edit an application key.
726730
// Edit an application key name.
731+
// This endpoint is disabled for organizations in [One-Time Read mode](https://docs.datadoghq.com/account_management/api-app-keys/#one-time-read-mode).
727732
func (a *KeyManagementApi) UpdateApplicationKey(ctx _context.Context, key string, body ApplicationKey) (ApplicationKeyResponse, *_nethttp.Response, error) {
728733
var (
729734
localVarHTTPMethod = _nethttp.MethodPut

api/datadogV2/api_key_management.go

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -592,7 +592,8 @@ func (a *KeyManagementApi) GetApplicationKey(ctx _context.Context, appKeyId stri
592592
}
593593

594594
// GetCurrentUserApplicationKey Get one application key owned by current user.
595-
// Get an application key owned by current user
595+
// Get an application key owned by current user.
596+
// 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).
596597
func (a *KeyManagementApi) GetCurrentUserApplicationKey(ctx _context.Context, appKeyId string) (ApplicationKeyResponse, *_nethttp.Response, error) {
597598
var (
598599
localVarHTTPMethod = _nethttp.MethodGet
@@ -1367,7 +1368,8 @@ func (a *KeyManagementApi) UpdateApplicationKey(ctx _context.Context, appKeyId s
13671368
}
13681369

13691370
// UpdateCurrentUserApplicationKey Edit an application key owned by current user.
1370-
// Edit an application key owned by current user
1371+
// Edit an application key owned by current user.
1372+
// 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).
13711373
func (a *KeyManagementApi) UpdateCurrentUserApplicationKey(ctx _context.Context, appKeyId string, body ApplicationKeyUpdateRequest) (ApplicationKeyResponse, *_nethttp.Response, error) {
13721374
var (
13731375
localVarHTTPMethod = _nethttp.MethodPatch

0 commit comments

Comments
 (0)