Merge pull request #16 from Flared/max/add-deprecated-apis-section

Add Deprecated APIs section
Flared · Sep 27, 2024 · ed745af · ed745af
2 parents a4c2eaf + dcf75d7
commit ed745af
Show file tree

Hide file tree

Showing 5 changed files with 39 additions and 6 deletions.
diff --git a/docs/api-reference/leaksdb/endpoints/get-by-domain.mdx b/docs/api-reference/leaksdb/endpoints/get-by-domain.mdx
@@ -1,11 +1,11 @@
 ---
-title: "List by Domain (deprecated)"
+title: "List by Domain"
 api: "GET https://api.flare.io/leaksdb/identities/by_domain/{domain}"
 ---
 
 <Warning>
 **DEPRECATED:** This endpoint should be replaced by
-[/credentials/_search <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/post-credentials-search).
+[/credentials/_search <Icon icon="code" size={16} />](/api-reference/leaksdb/endpoints/post-credentials-search)
 </Warning>
 
 Returns a list of accounts matching the domain provided.

diff --git a/docs/api-reference/v2/endpoints/identifiers/get-assets-feed.mdx b/docs/api-reference/v2/endpoints/identifiers/get-assets-feed.mdx
@@ -1,4 +1,9 @@
 ---
 openapi: firework-v2-openapi get /assets/{asset_id}/feed
 title: List Identifier Events
----
+---
+
+<Warning>
+**DEPRECATED:** This endpoint should be replaced by
+[/firework/v4/events/identifiers/\{identifier_id\}/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/identifier-feed)
+</Warning>
diff --git a/docs/api-reference/v2/endpoints/identifiers/get-assetsgroups-feed.mdx b/docs/api-reference/v2/endpoints/identifiers/get-assetsgroups-feed.mdx
@@ -1,4 +1,9 @@
 ---
 openapi: firework-v2-openapi get /assets/groups/{assets_group_id}/feed
 title: List Identifier Groups Events
----
+---
+
+<Warning>
+**DEPRECATED:** This endpoint should be replaced by
+[/firework/v4/events/identifier_groups/\{identifier_group_id\}/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/identifier-group-feed)
+</Warning>
diff --git a/docs/api-reference/v2/endpoints/me/get-mefeed.mdx b/docs/api-reference/v2/endpoints/me/get-mefeed.mdx
@@ -1,4 +1,9 @@
 ---
 openapi: firework-v2-openapi get /me/feed
 title: List Tenant Events
----
+---
+
+<Warning>
+**DEPRECATED:** This endpoint should be replaced by
+[/firework/v4/events/tenant/_search <Icon icon="code" size={16} />](/api-reference/v4/endpoints/current-tenant-feed)
+</Warning>
diff --git a/docs/mint.json b/docs/mint.json
@@ -145,7 +145,6 @@
         {
           "group": "Identities",
           "pages": [
-            "api-reference/leaksdb/endpoints/get-by-domain",
             "api-reference/leaksdb/endpoints/get-by-keyword",
             "api-reference/leaksdb/endpoints/post-by-accounts",
             "api-reference/leaksdb/endpoints/get-by-password"
@@ -259,6 +258,25 @@
           ]
         }
       ]
+    },
+    {
+      "group": "Deprecated APIs",
+      "pages": [
+        {
+          "group": "Identities",
+          "pages": [
+            "api-reference/leaksdb/endpoints/get-by-domain"
+          ]
+        },
+        {
+          "group": "Event Feeds",
+          "pages": [
+            "api-reference/v2/endpoints/me/get-mefeed",
+            "api-reference/v2/endpoints/identifiers/get-assets-feed",
+            "api-reference/v2/endpoints/identifiers/get-assetsgroups-feed"
+          ]
+        }
+      ]
     }
   ],
   "footerSocials": {