From 70167eadacff196197c5637892976c66cfb931ef Mon Sep 17 00:00:00 2001 From: Gabrielle Rouillard Date: Thu, 4 Jun 2026 16:59:53 -0400 Subject: [PATCH] Adding new identifiers endpoints to sidebar and deprecating the old endpoints --- .../identifiers/delete-fireworkv2assets.mdx | 7 +++++- .../post-fireworkv2assets-toggle.mdx | 7 +++++- .../identifiers/post-fireworkv2assets.mdx | 7 +++++- .../identifiers/put-fireworkv2assets.mdx | 7 +++++- .../get-fireworkv3identifiers-1.mdx | 7 +++++- .../identifiers/get-fireworkv3identifiers.mdx | 5 +++++ docs/docs.json | 22 ++++++++++++++----- 7 files changed, 51 insertions(+), 11 deletions(-) diff --git a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx index d380096..af3c108 100644 --- a/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/delete-fireworkv2assets.mdx @@ -1,4 +1,9 @@ --- openapi: firework-v2-openapi delete /firework/v2/assets/{asset_id} title: Delete Identifier ---- \ No newline at end of file +--- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/delete-identifier) + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx index 173a289..2a90c83 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle.mdx @@ -1,4 +1,9 @@ --- openapi: firework-v2-openapi post /firework/v2/assets/{asset_id}/toggle title: Enable/Disable Identifier ---- \ No newline at end of file +--- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/update-identifier) + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx index 5ab6e52..d824236 100644 --- a/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/post-fireworkv2assets.mdx @@ -1,4 +1,9 @@ --- openapi: firework-v2-openapi post /firework/v2/assets/ title: Create Identifier ---- \ No newline at end of file +--- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/ ](/api-reference/v4/endpoints/create-identifier) + \ No newline at end of file diff --git a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx index eb5f333..5dc875f 100644 --- a/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx +++ b/docs/api-reference/v2/endpoints/identifiers/put-fireworkv2assets.mdx @@ -1,4 +1,9 @@ --- openapi: firework-v2-openapi put /firework/v2/assets/{asset_id} title: Update Identifier ---- \ No newline at end of file +--- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/update-identifier) + \ No newline at end of file diff --git a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx index cb60749..708d947 100644 --- a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx +++ b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1.mdx @@ -1,4 +1,9 @@ --- openapi: firework-v3-openapi get /firework/v3/identifiers/{identifier_id} title: Retrieve Identifier ---- \ No newline at end of file +--- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/\{identifier_id\} ](/api-reference/v4/endpoints/retrieve-identifier) + \ No newline at end of file diff --git a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx index fbf8bb0..cc32648 100644 --- a/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx +++ b/docs/api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers.mdx @@ -2,3 +2,8 @@ openapi: firework-v3-openapi get /firework/v3/identifiers/ title: List Identifiers --- + + +**DEPRECATED:** This endpoint should be replaced by +[/firework/v4/identifiers/ ](/api-reference/v4/endpoints/list-identifiers) + diff --git a/docs/docs.json b/docs/docs.json index 182ca0a..5d345be 100644 --- a/docs/docs.json +++ b/docs/docs.json @@ -134,12 +134,11 @@ { "group": "Identifiers", "pages": [ - "api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers", - "api-reference/v2/endpoints/identifiers/post-fireworkv2assets", - "api-reference/v2/endpoints/identifiers/put-fireworkv2assets", - "api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1", - "api-reference/v2/endpoints/identifiers/delete-fireworkv2assets", - "api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle" + "api-reference/v4/endpoints/list-identifiers", + "api-reference/v4/endpoints/create-identifier", + "api-reference/v4/endpoints/update-identifier", + "api-reference/v4/endpoints/retrieve-identifier", + "api-reference/v4/endpoints/delete-identifier" ] }, { @@ -277,6 +276,17 @@ "api-reference/v2/endpoints/identifiers/get-fireworkv2assets-feed", "api-reference/v2/endpoints/identifiers/get-fireworkv2assetsgroups-feed" ] + }, + { + "group": "Identifiers", + "pages": [ + "api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers", + "api-reference/v2/endpoints/identifiers/post-fireworkv2assets", + "api-reference/v2/endpoints/identifiers/put-fireworkv2assets", + "api-reference/v3/endpoints/identifiers/get-fireworkv3identifiers-1", + "api-reference/v2/endpoints/identifiers/delete-fireworkv2assets", + "api-reference/v2/endpoints/identifiers/post-fireworkv2assets-toggle" + ] } ] }