Merge pull request #324 from KomodoPlatform/kdf/rename-method

KomodoPlatform · Oct 31, 2024 · 1da1d1c · 1da1d1c
2 parents 20a038d + 52b79cd
commit 1da1d1c
Show file tree

Hide file tree

Showing 3 changed files with 14 additions and 22 deletions.
diff --git a/filepathSlugs.json b/filepathSlugs.json
@@ -2325,6 +2325,12 @@
     "response-error-active-swap-is-using-the-coin",
     "response-error-the-order-is-matched-at-the-moment-but-another-order-is-cancelled"
   ],
+  "src/pages/komodo-defi-framework/api/legacy/get_directly_connected_peers/index.mdx": [
+    "get-directly-connected-peers",
+    "arguments",
+    "response",
+    "example"
+  ],
   "src/pages/komodo-defi-framework/api/legacy/get_enabled_coins/index.mdx": [
     "get-enabled-coins",
     "arguments",
@@ -2365,14 +2371,6 @@
     "command",
     "response-success"
   ],
-  "src/pages/komodo-defi-framework/api/legacy/get_peers_info/index.mdx": [
-    "get-peers-info",
-    "arguments",
-    "response",
-    "examples",
-    "command",
-    "response-success"
-  ],
   "src/pages/komodo-defi-framework/api/legacy/get_relay_mesh/index.mdx": [
     "get-relay-mesh",
     "arguments",

diff --git a/src/data/sidebar.json b/src/data/sidebar.json
@@ -731,8 +731,8 @@
             "href": "/komodo-defi-framework/api/legacy/get_my_peer_id/"
           },
           {
-            "title": "get_peers_info",
-            "href": "/komodo-defi-framework/api/legacy/get_peers_info/"
+            "title": "get_directly_connected_peers",
+            "href": "/komodo-defi-framework/api/legacy/get_directly_connected_peers/"
           },
           {
             "title": "get_relay_mesh",

diff --git a/...ework/api/legacy/get_peers_info/index.mdx → ...cy/get_directly_connected_peers/index.mdx b/...ework/api/legacy/get_peers_info/index.mdx → ...cy/get_directly_connected_peers/index.mdx
@@ -1,11 +1,9 @@
 export const title = "Komodo DeFi Framework Method: Get Peers Info";
-export const description = "The get_peers_info method all connected peers with their multiaddresses.";
+export const description = "The get_directly_connected_peers method returns an array of peers (with their multiaddresses) currently connected to the requesting node.";
 
-# get\_peers\_info
+# get\_directly\_connected\_peers
 
-**get\_peers\_info**
-
-The `get_peers_info` method all connected peers with their multiaddresses. See [https://docs.libp2p.io/concepts/addressing/](https://docs.libp2p.io/concepts/addressing/) for more information.
+The `get_directly_connected_peers` method all connected peers with their multiaddresses. See [https://docs.libp2p.io/concepts/addressing/](https://docs.libp2p.io/concepts/addressing/) for more information.
 
 ## Arguments
 
@@ -19,22 +17,18 @@ The `get_peers_info` method all connected peers with their multiaddresses. See [
 | --------------------- | ----- | ---------------------------------------------- |
 | PeerID-Multiaddresses | Array | All connected peers with their multiaddresses. |
 
-#### 📌 Examples
-
-#### Command
+#### 📌 Example
 
-<CodeGroup title="" tag="POST" label="get_peers_info" mm2MethodDecorate="true">
+<CodeGroup title="" tag="POST" label="get_directly_connected_peers" mm2MethodDecorate="true">
   ```json
   {
     "userpass": "RPC_UserP@SSW0RD",
-    "method": "get_peers_info"
+    "method": "get_directly_connected_peers"
   }
   ```
 </CodeGroup>
 
 <CollapsibleSection expandedText="Hide Response" collapsedText="Show Response">
-  #### Response (success)
-
   ```json
   {
     "result": {