Skip to content

Commit 4fa3a1c

Browse files
api-clients-generation-pipeline[bot]ci.datadog-api-spec
andauthored
fix(aws): mark v1 endpoints which have v2 replacement as deprecated (#2908)
Co-authored-by: ci.datadog-api-spec <packages@datadoghq.com>
1 parent 732686d commit 4fa3a1c

File tree

4 files changed

+42
-26
lines changed

4 files changed

+42
-26
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':

services/aws_integration/src/v1/AWSIntegrationApi.ts

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1497,7 +1497,7 @@ export class AWSIntegrationApi {
14971497
}
14981498

14991499
/**
1500-
* Create a Datadog-Amazon Web Services integration.
1500+
* "**This endpoint is deprecated - use the V2 endpoints instead.** Create a Datadog-Amazon Web Services integration.
15011501
* Using the `POST` method updates your integration configuration
15021502
* by adding your new configuration to the existing one in your Datadog organization.
15031503
* A unique AWS Account ID for role based authentication.
@@ -1563,7 +1563,7 @@ export class AWSIntegrationApi {
15631563
}
15641564

15651565
/**
1566-
* Generate a new AWS external ID for a given AWS account ID and role name pair.
1566+
* **This endpoint is deprecated - use the V2 endpoints instead.** Generate a new AWS external ID for a given AWS account ID and role name pair.
15671567
* @param param The request object
15681568
*/
15691569
public createNewAWSExternalID(
@@ -1584,7 +1584,7 @@ export class AWSIntegrationApi {
15841584
}
15851585

15861586
/**
1587-
* Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
1587+
* **This endpoint is deprecated - use the V2 endpoints instead.** Delete a Datadog-AWS integration matching the specified `account_id` and `role_name parameters`.
15881588
* @param param The request object
15891589
*/
15901590
public deleteAWSAccount(
@@ -1647,7 +1647,7 @@ export class AWSIntegrationApi {
16471647
}
16481648

16491649
/**
1650-
* List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
1650+
* **This endpoint is deprecated - use the V2 endpoints instead.** List all namespace rules for a given Datadog-AWS integration. This endpoint takes no arguments.
16511651
* @param param The request object
16521652
*/
16531653
public listAvailableAWSNamespaces(
@@ -1667,7 +1667,7 @@ export class AWSIntegrationApi {
16671667
}
16681668

16691669
/**
1670-
* List all Datadog-AWS integrations available in your Datadog organization.
1670+
* **This endpoint is deprecated - use the V2 endpoints instead.** List all Datadog-AWS integrations available in your Datadog organization.
16711671
* @param param The request object
16721672
*/
16731673
public listAWSAccounts(
@@ -1731,7 +1731,7 @@ export class AWSIntegrationApi {
17311731
}
17321732

17331733
/**
1734-
* Update a Datadog-Amazon Web Services integration.
1734+
* **This endpoint is deprecated - use the V2 endpoints instead.** Update a Datadog-Amazon Web Services integration.
17351735
* @param param The request object
17361736
*/
17371737
public updateAWSAccount(

services/aws_integration/src/v1/models/AWSAccount.ts

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,11 @@ export class AWSAccount {
1313
*/
1414
"accountId"?: string;
1515
/**
16-
* An object, (in the form `{"namespace1":true/false, "namespace2":true/false}`),
17-
* that enables or disables metric collection for specific AWS namespaces for this
18-
* AWS account only.
16+
* An object (in the form `{"namespace1":true/false, "namespace2":true/false}`) containing user-supplied overrides
17+
* for AWS namespace metric collection. **Important**: This field only contains namespaces explicitly configured through API calls,
18+
* not the comprehensive enabled or disabled status of all namespaces. If a namespace is absent from this field, it uses Datadog's
19+
* internal defaults (all namespaces enabled by default, except `AWS/SQS`, `AWS/ElasticMapReduce`, and `AWS/Usage`).
20+
* For a complete view of all namespace statuses, use the V2 AWS Integration API instead.
1921
*/
2022
"accountSpecificNamespaceRules"?: { [key: string]: boolean };
2123
/**

services/aws_logs_integration/src/v1/AWSLogsIntegrationApi.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -978,7 +978,7 @@ export class AWSLogsIntegrationApi {
978978
}
979979

980980
/**
981-
* Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
981+
* **This endpoint is deprecated - use the V2 endpoint instead.** Get the list of current AWS services that Datadog offers automatic log collection. Use returned service IDs with the services parameter for the Enable an AWS service log collection API endpoint.
982982
* @param param The request object
983983
*/
984984
public listAWSLogsServices(

0 commit comments

Comments
 (0)