Skip to content

Commit ddaddfa

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
fix(aws): mark v1 endpoints which have v2 replacement as deprecated (#3200)
Co-authored-by: ci.datadog-api-spec <[email protected]>
1 parent 6d16257 commit ddaddfa

File tree

4 files changed

+55
-29
lines changed

4 files changed

+55
-29
lines changed

.generator/schemas/v1/openapi.yaml

Lines changed: 30 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -64,12 +64,20 @@ components:
6464
additionalProperties:
6565
description: A list of additional properties.
6666
type: boolean
67-
description: 'An object, (in the form `{"namespace1":true/false, "namespace2":true/false}`),
67+
description: 'An object (in the form `{"namespace1":true/false, "namespace2":true/false}`)
68+
containing user-supplied overrides
6869

69-
that enables or disables metric collection for specific AWS namespaces
70-
for this
70+
for AWS namespace metric collection. **Important**: This field only contains
71+
namespaces explicitly configured through API calls,
7172

72-
AWS account only.'
73+
not the comprehensive enabled or disabled status of all namespaces. If
74+
a namespace is absent from this field, it uses Datadog''s
75+
76+
internal defaults (all namespaces enabled by default, except `AWS/SQS`,
77+
`AWS/ElasticMapReduce`, and `AWS/Usage`).
78+
79+
For a complete view of all namespace statuses, use the V2 AWS Integration
80+
API instead.'
7381
example:
7482
auto_scaling: false
7583
opswork: false
@@ -28067,8 +28075,9 @@ paths:
2806728075
/api/v1/integration/aws:
2806828076
delete:
2806928077
deprecated: true
28070-
description: Delete a Datadog-AWS integration matching the specified `account_id`
28071-
and `role_name parameters`.
28078+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28079+
Delete a Datadog-AWS integration matching the specified `account_id` and `role_name
28080+
parameters`.'
2807228081
operationId: DeleteAWSAccount
2807328082
requestBody:
2807428083
content:
@@ -28114,7 +28123,8 @@ paths:
2811428123
- aws_configurations_manage
2811528124
get:
2811628125
deprecated: true
28117-
description: List all Datadog-AWS integrations available in your Datadog organization.
28126+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28127+
List all Datadog-AWS integrations available in your Datadog organization.'
2811828128
operationId: ListAWSAccounts
2811928129
parameters:
2812028130
- description: Only return AWS accounts that matches this `account_id`.
@@ -28165,7 +28175,8 @@ paths:
2816528175
- aws_configuration_read
2816628176
post:
2816728177
deprecated: true
28168-
description: 'Create a Datadog-Amazon Web Services integration.
28178+
description: '"**This endpoint is deprecated - use the V2 endpoints instead.**
28179+
Create a Datadog-Amazon Web Services integration.
2816928180

2817028181
Using the `POST` method updates your integration configuration
2817128182

@@ -28217,7 +28228,8 @@ paths:
2821728228
- aws_configurations_manage
2821828229
put:
2821928230
deprecated: true
28220-
description: Update a Datadog-Amazon Web Services integration.
28231+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28232+
Update a Datadog-Amazon Web Services integration.'
2822128233
operationId: UpdateAWSAccount
2822228234
parameters:
2822328235
- description: Only return AWS accounts that matches this `account_id`.
@@ -28287,8 +28299,9 @@ paths:
2828728299
/api/v1/integration/aws/available_namespace_rules:
2828828300
get:
2828928301
deprecated: true
28290-
description: List all namespace rules for a given Datadog-AWS integration. This
28291-
endpoint takes no arguments.
28302+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28303+
List all namespace rules for a given Datadog-AWS integration. This endpoint
28304+
takes no arguments.'
2829228305
operationId: ListAvailableAWSNamespaces
2829328306
responses:
2829428307
'200':
@@ -28563,8 +28576,8 @@ paths:
2856328576
/api/v1/integration/aws/generate_new_external_id:
2856428577
put:
2856528578
deprecated: true
28566-
description: Generate a new AWS external ID for a given AWS account ID and role
28567-
name pair.
28579+
description: '**This endpoint is deprecated - use the V2 endpoints instead.**
28580+
Generate a new AWS external ID for a given AWS account ID and role name pair.'
2856828581
operationId: CreateNewAWSExternalID
2856928582
requestBody:
2857028583
content:
@@ -28791,9 +28804,10 @@ paths:
2879128804
/api/v1/integration/aws/logs/services:
2879228805
get:
2879328806
deprecated: true
28794-
description: Get the list of current AWS services that Datadog offers automatic
28795-
log collection. Use returned service IDs with the services parameter for the
28796-
Enable an AWS service log collection API endpoint.
28807+
description: '**This endpoint is deprecated - use the V2 endpoint instead.**
28808+
Get the list of current AWS services that Datadog offers automatic log collection.
28809+
Use returned service IDs with the services parameter for the Enable an AWS
28810+
service log collection API endpoint.'
2879728811
operationId: ListAWSLogsServices
2879828812
responses:
2879928813
'200':

src/main/java/com/datadog/api/client/v1/api/AwsIntegrationApi.java

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -89,9 +89,10 @@ public CompletableFuture<AWSAccountCreateResponse> createAWSAccountAsync(AWSAcco
8989
}
9090

9191
/**
92-
* Create a Datadog-Amazon Web Services integration. Using the <code>POST</code> method updates
93-
* your integration configuration by adding your new configuration to the existing one in your
94-
* Datadog organization. A unique AWS Account ID for role based authentication.
92+
* "<strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> Create a
93+
* Datadog-Amazon Web Services integration. Using the <code>POST</code> method updates your
94+
* integration configuration by adding your new configuration to the existing one in your Datadog
95+
* organization. A unique AWS Account ID for role based authentication.
9596
*
9697
* @param body AWS Request Object (required)
9798
* @return ApiResponse&lt;AWSAccountCreateResponse&gt;
@@ -539,7 +540,8 @@ public CompletableFuture<AWSAccountCreateResponse> createNewAWSExternalIDAsync(A
539540
}
540541

541542
/**
542-
* Generate a new AWS external ID for a given AWS account ID and role name pair.
543+
* <strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> Generate a new AWS
544+
* external ID for a given AWS account ID and role name pair.
543545
*
544546
* @param body Your Datadog role delegation name. For more information about your AWS account Role
545547
* name, see the <a
@@ -685,7 +687,8 @@ public CompletableFuture<Object> deleteAWSAccountAsync(AWSAccountDeleteRequest b
685687
}
686688

687689
/**
688-
* Delete a Datadog-AWS integration matching the specified <code>account_id</code> and <code>
690+
* <strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> Delete a
691+
* Datadog-AWS integration matching the specified <code>account_id</code> and <code>
689692
* role_name parameters</code>.
690693
*
691694
* @param body AWS request object (required)
@@ -1118,7 +1121,8 @@ public CompletableFuture<List<String>> listAvailableAWSNamespacesAsync() {
11181121
}
11191122

11201123
/**
1121-
* List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
1124+
* <strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> List all namespace
1125+
* rules for a given Datadog-AWS integration. This endpoint takes no arguments.
11221126
*
11231127
* @return ApiResponse&lt;List&lt;String&gt;&gt;
11241128
* @throws ApiException if fails to make API call
@@ -1314,7 +1318,8 @@ public CompletableFuture<AWSAccountListResponse> listAWSAccountsAsync(
13141318
}
13151319

13161320
/**
1317-
* List all Datadog-AWS integrations available in your Datadog organization.
1321+
* <strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> List all
1322+
* Datadog-AWS integrations available in your Datadog organization.
13181323
*
13191324
* @param parameters Optional parameters for the request.
13201325
* @return ApiResponse&lt;AWSAccountListResponse&gt;
@@ -1802,7 +1807,8 @@ public CompletableFuture<Object> updateAWSAccountAsync(
18021807
}
18031808

18041809
/**
1805-
* Update a Datadog-Amazon Web Services integration.
1810+
* <strong>This endpoint is deprecated - use the V2 endpoints instead.</strong> Update a
1811+
* Datadog-Amazon Web Services integration.
18061812
*
18071813
* @param body AWS request object (required)
18081814
* @param parameters Optional parameters for the request.

src/main/java/com/datadog/api/client/v1/api/AwsLogsIntegrationApi.java

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -892,9 +892,9 @@ public CompletableFuture<List<AWSLogsListServicesResponse>> listAWSLogsServicesA
892892
}
893893

894894
/**
895-
* Get the list of current AWS services that Datadog offers automatic log collection. Use returned
896-
* service IDs with the services parameter for the Enable an AWS service log collection API
897-
* endpoint.
895+
* <strong>This endpoint is deprecated - use the V2 endpoint instead.</strong> Get the list of
896+
* current AWS services that Datadog offers automatic log collection. Use returned service IDs
897+
* with the services parameter for the Enable an AWS service log collection API endpoint.
898898
*
899899
* @return ApiResponse&lt;List&lt;AWSLogsListServicesResponse&gt;&gt;
900900
* @throws ApiException if fails to make API call

src/main/java/com/datadog/api/client/v1/model/AWSAccount.java

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -136,8 +136,14 @@ public AWSAccount putAccountSpecificNamespaceRulesItem(
136136
}
137137

138138
/**
139-
* An object, (in the form <code>{"namespace1":true/false, "namespace2":true/false}</code>), that
140-
* enables or disables metric collection for specific AWS namespaces for this AWS account only.
139+
* An object (in the form <code>{"namespace1":true/false, "namespace2":true/false}</code>)
140+
* containing user-supplied overrides for AWS namespace metric collection.
141+
* <strong>Important</strong>: This field only contains namespaces explicitly configured through
142+
* API calls, not the comprehensive enabled or disabled status of all namespaces. If a namespace
143+
* is absent from this field, it uses Datadog's internal defaults (all namespaces enabled by
144+
* default, except <code>AWS/SQS</code>, <code>AWS/ElasticMapReduce</code>, and <code>AWS/Usage
145+
* </code>). For a complete view of all namespace statuses, use the V2 AWS Integration API
146+
* instead.
141147
*
142148
* @return accountSpecificNamespaceRules
143149
*/

0 commit comments

Comments
 (0)