Skip to content

Commit 930c46b

Browse files
author
Pierre Guceski
authored
Merge pull request DataDog#6807 from DataDog/gus/api-update
[DOCS-704] Adding PUT/POST disclaimer
2 parents 43753ae + f45af74 commit 930c46b

File tree

12 files changed

+33
-5
lines changed

12 files changed

+33
-5
lines changed

content/en/api/integrations_pagerduty/code_snippets/pagerduty_add_services.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,4 +20,7 @@
2020

2121
dog = Dogapi::Client.new(api_key, app_key)
2222

23+
# Warning: this function makes a PUT call to the Datadog API
24+
# It updates your integration configuration by REPLACING
25+
# your current configuration with the new one.
2326
dog.update_integration('pagerduty', config)

content/en/api/integrations_pagerduty/pagerduty_add_services.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ external_redirect: /api/#add-new-services-and-schedules
99

1010
Add new services and schedules to your Datadog-PagerDuty integration.
1111

12+
**Note**:
13+
14+
* Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
15+
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
16+
1217
**ARGUMENTS**:
1318

1419
* **`services`** :

content/en/api/integrations_pagerduty/pagerduty_add_services_code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ external_redirect: /api/#add-new-services-and-schedules
77

88
**SIGNATURE**:
99

10-
`POST /v1/integration/pagerduty`
10+
`PUT /v1/integration/pagerduty`
1111

1212
**EXAMPLE REQUEST**:
1313

content/en/api/integrations_pagerduty/pagerduty_create.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,10 @@ external_redirect: /api/#create-a-pagerduty-integration
99

1010
Create a new Datadog-PagerDuty integration.
1111

12-
**Note**: All arguments are required when creating (`PUT`) a new PagerDuty configuration.
12+
**Note**:
13+
14+
* Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
15+
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization. All arguments are required when creating (`PUT`) a new PagerDuty configuration.
1316

1417
**ARGUMENTS**:
1518

content/en/api/integrations_slack/code_snippets/slack_add_channels.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,4 +21,7 @@
2121

2222
dog = Dogapi::Client.new(api_key, app_key)
2323

24+
# Warning: this function makes a PUT call to the Datadog API
25+
# It updates your integration configuration by REPLACING
26+
# your current configuration with the new one.
2427
dog.update_integration('slack', config)

content/en/api/integrations_slack/slack_add_channels.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ external_redirect: /api/#add-channels-to-slack-integration
99

1010
Add channels to your Datadog-Slack integration.
1111

12+
**Note**:
13+
14+
* Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
15+
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
16+
1217
**ARGUMENTS**:
1318

1419
* **`channels`** [*required*]:

content/en/api/integrations_slack/slack_add_channels_code.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ external_redirect: /api/#add-channels-to-slack-integration
77

88
**SIGNATURE**:
99

10-
`POST /v1/integration/slack`
10+
`PUT /v1/integration/slack`
1111

1212
**EXAMPLE REQUEST**:
1313

content/en/api/integrations_slack/slack_create.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ Create a Datadog-Slack integration. Once created, add a channel to it with the [
1212
**Note**:
1313

1414
* Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
15-
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
15+
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization. All arguments are required when creating (`PUT`) a new Slack configuration.
1616

1717
**ARGUMENTS**:
1818

content/en/api/integrations_webhook/code_snippets/webhooks_add_webhook.rb

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,7 @@
1515

1616
dog = Dogapi::Client.new(api_key, app_key)
1717

18+
# Warning: this function makes a PUT call to the Datadog API
19+
# It updates your integration configuration by REPLACING
20+
# your current configuration with the new one.
1821
dog.update_integration('webhooks', config)

content/en/api/integrations_webhook/webhooks_add_webhook.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,11 @@ external_redirect: /api/#update-a-webhooks-integration
99

1010
Add a specific Webhook to a Datadog Webhooks integration.
1111

12+
**Note**:
13+
14+
* Using the `POST` method updates your integration configuration by **adding** your new configuration to the existing one in your Datadog organization.
15+
* Using the `PUT` method updates your integration configuration by **replacing** your current configuration with the new one sent to your Datadog organization.
16+
1217
**ARGUMENTS**:
1318

1419
* **`hooks`** [*required*]:

0 commit comments

Comments
 (0)