Minor fix to api.yaml

input-output-hk · Aug 8, 2022 · a73ac4c · a73ac4c
1 parent f5373b9
commit a73ac4c
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 3 deletions.
diff --git a/hydra-node/json-schemas/api.yaml b/hydra-node/json-schemas/api.yaml
@@ -566,7 +566,7 @@ components:
           peers:
             type: array
             items:
-              $ref: "api.yaml#/components/schemas/Peer"
+              $ref: "#/components/schemas/Peer"
 
     CommandFailed:
       title: CommandFailed

diff --git a/hydra-node/src/Hydra/Network.hs b/hydra-node/src/Hydra/Network.hs
@@ -42,8 +42,10 @@ import Text.Show (Show (show))
 data Network m msg = Network
   { -- | Send a `msg` to the whole hydra network.
     broadcast :: msg -> m ()
-  , -- | Returns the list of connected peers in the whole hydra network.
-    getPeers :: [Host]
+    -- | Returns the list of connected peers in the hydra network.
+  , getPeers :: [Host]
+    -- | Modify the list of peers in the hydra network,
+    -- causing the network to reinitialize and reconnect to the new list of peers.
   , setPeers :: [Host] -> m ()
   }