Document the change in peers endpoint

stellar · Apr 15, 2022 · 0064a59 · 0064a59 · latobarita · Apr 16, 2022
1 parent e654239
commit 0064a59
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/docs/software/admin.md b/docs/software/admin.md
@@ -697,6 +697,7 @@ Some notable fields in `info` are:
 The `peers` command returns information on the peers the instance is connected to.
 
 This list is the result of both inbound connections from other peers and outbound connections from this node to other peers.
+If `compact=false`, then it also returns some extra metrics on each peer such as the number of dropped messages.
 
 `$ stellar-core http-command 'peers'`
 

diff --git a/docs/software/commands.md b/docs/software/commands.md
@@ -179,9 +179,10 @@ format.
   Clear metrics for a specified domain. If no domain specified, clear all
   metrics (for testing purposes).
 
-* **peers?[&fullkeys=false]**
-  Returns the list of known peers in JSON format.
+* **peers?[&fullkeys=false&compact=true]**
+  Returns the list of known peers in JSON format with some metrics.
   If `fullkeys` is set, outputs unshortened public keys.
+  If `compact` is `false`, it will output extra metrics.
 
 * **quorum**
   `quorum?[node=NODE_ID][&compact=false][&fullkeys=false][&transitive=false]`<br>