Update Idempotency-Key usage in documentation (#192)

* [FND-3122] Remove idempotency key for refresh token endpoint * [FND-3130] Add idempotency key to all update endpoints
cobalthq · Aug 15, 2023 · cdacdc3 · cdacdc3
1 parent fe5082c
commit cdacdc3
Show file tree

Hide file tree

Showing 4 changed files with 4 additions and 2 deletions.
diff --git a/versions/v2/content/assets.md b/versions/v2/content/assets.md
@@ -214,6 +214,7 @@ curl -X PUT 'https://api.cobalt.io/assets/AN-ASSET-IDENTIFIER' \
   -H 'Accept: application/vnd.cobalt.v2+json' \
   -H 'Authorization: Bearer YOUR-PERSONAL-API-TOKEN' \
   -H 'Content-Type: application/vnd.cobalt.v2+json' \
+  -H 'Idempotency-Key: A-UNIQUE-IDENTIFIER-TO-PREVENT-UNINTENTIONAL-DUPLICATION' \
   -H 'X-Org-Token: YOUR-V2-ORGANIZATION-TOKEN' \
   --data '{
             "title": "Updated title",

diff --git a/versions/v2/content/tokens.md b/versions/v2/content/tokens.md
@@ -61,8 +61,7 @@ This endpoint retrieves a list of all tokens that belong to you.
 ```sh
 curl -X POST "https://api.cobalt.io/tokens/YOUR-TOKEN-ID/refresh" \
   -H "Accept: application/vnd.cobalt.v2+json" \
-  -H "Authorization: Bearer YOUR-PERSONAL-API-TOKEN" \
-  -H "Idempotency-Key: A-UNIQUE-IDENTIFIER-TO-PREVENT-UNINTENTIONAL-DUPLICATION"
+  -H "Authorization: Bearer YOUR-PERSONAL-API-TOKEN"
 ```
 
 > The above command returns JSON structured like this:

diff --git a/versions/v2/content/update-finding-state.md b/versions/v2/content/update-finding-state.md
@@ -63,6 +63,7 @@ This endpoint retrieves the current state of a finding as well as possible next
 curl -X PATCH "https://api.cobalt.io/findings/YOUR-FINDING-ID" \
   -H "Accept: application/vnd.cobalt.v2+json" \
   -H 'Content-Type: application/vnd.cobalt.v2+json' \
+  -H "Idempotency-Key: A-UNIQUE-IDENTIFIER-TO-PREVENT-UNINTENTIONAL-DUPLICATION" \
   -H "Authorization: Bearer YOUR-PERSONAL-API-TOKEN" \
   -H "X-Org-Token: YOUR-V2-ORGANIZATION-TOKEN" \
   -d '{"state":"triaging"}'

diff --git a/versions/v2/content/webhooks.md b/versions/v2/content/webhooks.md
@@ -191,6 +191,7 @@ curl -X PATCH 'https://api.cobalt.io/webhooks/YOUR-WEBHOOK-IDENTIFIER' \
   -H 'Accept: application/vnd.cobalt.v2+json' \
   -H 'Authorization: Bearer YOUR-PERSONAL-API-TOKEN' \
   -H 'Content-Type: application/vnd.cobalt.v2+json' \
+  -H 'Idempotency-Key: A-UNIQUE-IDENTIFIER-TO-PREVENT-UNINTENTIONAL-DUPLICATION' \
   -H 'X-Org-Token: YOUR-V2-ORGANIZATION-TOKEN' \
   --data '{
             "name": "FooBar",