add identifiers /feed/credentials endpoint to documentation

Flared · Jan 23, 2025 · aa2f182 · aa2f182
1 parent d8b4e2e
commit aa2f182
Show file tree

Hide file tree

Showing 7 changed files with 55 additions and 100 deletions.
diff --git a/docs/api-reference/spec/firework-v2-openapi.json b/docs/api-reference/spec/firework-v2-openapi.json
diff --git a/docs/api-reference/spec/firework-v2-swagger.json b/docs/api-reference/spec/firework-v2-swagger.json
diff --git a/docs/api-reference/spec/firework-v3-openapi.json b/docs/api-reference/spec/firework-v3-openapi.json
@@ -469,7 +469,7 @@
                         }
                     },
                     {
-                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_topic, listing, ransomleak, stealer_log, financial_data, chat_message, forum_post, seller, blog_post, forum_profile, bot\n- open_web: bucket, social_media, stack_exchange, paste, source_code_files, google, source_code_secrets, service, bucket_object\n- leaks: leak\n- domains: domain\n",
+                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, forum_topic, chat_message, forum_profile, financial_data, bot, stealer_log, seller, listing, blog_post, ransomleak\n- open_web: stack_exchange, bucket_object, paste, bucket, source_code_secrets, social_media, source_code_files, service, google\n- leaks: leak\n- domains: domain\n",
                         "explode": true,
                         "in": "query",
                         "name": "types",
@@ -786,7 +786,7 @@
                         }
                     },
                     {
-                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_topic, listing, ransomleak, stealer_log, financial_data, chat_message, forum_post, seller, blog_post, forum_profile, bot\n- open_web: bucket, social_media, stack_exchange, paste, source_code_files, google, source_code_secrets, service, bucket_object\n- leaks: leak\n- domains: domain\n",
+                        "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, forum_topic, chat_message, forum_profile, financial_data, bot, stealer_log, seller, listing, blog_post, ransomleak\n- open_web: stack_exchange, bucket_object, paste, bucket, source_code_secrets, social_media, source_code_files, service, google\n- leaks: leak\n- domains: domain\n",
                         "explode": true,
                         "in": "query",
                         "name": "types",
@@ -2390,12 +2390,6 @@
             },
             "PaginatedIdentifierGroupsWithCounts": {
                 "properties": {
-                    "cursors": {
-                        "items": {
-                            "type": "string"
-                        },
-                        "type": "array"
-                    },
                     "items": {
                         "$ref": "#/components/schemas/IdentifierGroupWithCounts"
                     },
@@ -2407,12 +2401,6 @@
             },
             "PaginatedIdentifierRelations": {
                 "properties": {
-                    "cursors": {
-                        "items": {
-                            "type": "string"
-                        },
-                        "type": "array"
-                    },
                     "items": {
                         "$ref": "#/components/schemas/Identifier"
                     },
@@ -2424,12 +2412,6 @@
             },
             "PaginatedIdentifiers": {
                 "properties": {
-                    "cursors": {
-                        "items": {
-                            "type": "string"
-                        },
-                        "type": "array"
-                    },
                     "items": {
                         "$ref": "#/components/schemas/Identifier"
                     },

diff --git a/docs/api-reference/spec/firework-v3-swagger.json b/docs/api-reference/spec/firework-v3-swagger.json
@@ -726,12 +726,6 @@
     },
     "PaginatedIdentifierGroupsWithCounts": {
       "properties": {
-        "cursors": {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        },
         "items": {
           "$ref": "#/definitions/IdentifierGroupWithCounts"
         },
@@ -750,12 +744,6 @@
     },
     "PaginatedIdentifierRelations": {
       "properties": {
-        "cursors": {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        },
         "items": {
           "$ref": "#/definitions/Identifier"
         },
@@ -774,12 +762,6 @@
     },
     "PaginatedIdentifiers": {
       "properties": {
-        "cursors": {
-          "items": {
-            "type": "string"
-          },
-          "type": "array"
-        },
         "items": {
           "$ref": "#/definitions/Identifier"
         },
@@ -1241,7 +1223,7 @@
           },
           {
             "collectionFormat": "multi",
-            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_topic, listing, ransomleak, stealer_log, financial_data, chat_message, forum_post, seller, blog_post, forum_profile, bot\n- open_web: bucket, social_media, stack_exchange, paste, source_code_files, google, source_code_secrets, service, bucket_object\n- leaks: leak\n- domains: domain\n",
+            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, forum_topic, chat_message, forum_profile, financial_data, bot, stealer_log, seller, listing, blog_post, ransomleak\n- open_web: stack_exchange, bucket_object, paste, bucket, source_code_secrets, social_media, source_code_files, service, google\n- leaks: leak\n- domains: domain\n",
             "enum": [
               "attachment",
               "listing",
@@ -1502,7 +1484,7 @@
           },
           {
             "collectionFormat": "multi",
-            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_topic, listing, ransomleak, stealer_log, financial_data, chat_message, forum_post, seller, blog_post, forum_profile, bot\n- open_web: bucket, social_media, stack_exchange, paste, source_code_files, google, source_code_secrets, service, bucket_object\n- leaks: leak\n- domains: domain\n",
+            "description": "\nType of activities to search through.\n\n*Expected values* : attachment, listing, ransomleak, forum_post, forum_topic, forum_profile, blog_post, seller, paste, leak, chat_message, chat_message/telegram, domain, bot, stealer_log, infected_devices, driller, driller_forum_topic, driller_forum_post, driller_profile, cc, ccbin, financial_data, leaked_data, leaked_file, document, account, actor, forum_content, blog_content, profile, illicit_networks, open_web, domains, leaks, social_media_account, social_media, source_code, source_code_secrets, source_code_files, stack_exchange, google, service, driller_host, buckets, bucket, bucket_object, whois, experimental\n\n*Some search types contain others*\n- illicit_networks: forum_post, forum_topic, chat_message, forum_profile, financial_data, bot, stealer_log, seller, listing, blog_post, ransomleak\n- open_web: stack_exchange, bucket_object, paste, bucket, source_code_secrets, social_media, source_code_files, service, google\n- leaks: leak\n- domains: domain\n",
             "enum": [
               "attachment",
               "listing",

diff --git a/docs/api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials.mdx b/docs/api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials.mdx
@@ -1,3 +1,4 @@
 ---
 openapi: firework-v3-openapi get /identifiers/{identifier_id}/feed/credentials
----
+title: List Identifier Credentials
+---
diff --git a/docs/api-reference/v3/endpoints/identifiers/post-identifiers-feedcredentials.mdx b/docs/api-reference/v3/endpoints/identifiers/post-identifiers-feedcredentials.mdx
@@ -1,3 +1,3 @@
 ---
-openapi: firework-v3-openapi post /identifiers/{identifier_id}/feed/credentials
+openapi: post /identifiers/{identifier_id}/feed/credentials
 ---
diff --git a/docs/mint.json b/docs/mint.json
@@ -178,6 +178,7 @@
           "pages": [
             "api-reference/v4/endpoints/current-tenant-feed",
             "api-reference/v2/endpoints/me/get-mefeedcredentials",
+            "api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials",
             "api-reference/v4/endpoints/identifier-feed",
             "api-reference/v4/endpoints/identifier-group-feed"
           ]
@@ -296,6 +297,7 @@
           "group": "Event Feeds",
           "pages": [
             "api-reference/v2/endpoints/me/get-mefeed",
+            "api-reference/v3/endpoints/identifiers/get-identifiers-feedcredentials",
             "api-reference/v2/endpoints/identifiers/get-assets-feed",
             "api-reference/v2/endpoints/identifiers/get-assetsgroups-feed"
           ]