docs: fix Router config Godoc (#9528)
Co-authored-by: Marcin Rataj <lidel@lidel.org>
Antonio Navarro Perez committed
Jan 5, 2023 at 13:30 UTC
1f3e1d1120e902f5b759d0d0c202349ccf14d634
1 file changed
+6
-9
config/routing.go
+6
-9
@@ -22,10 +22,7 @@ type Routing struct {
22
23
type Router struct {
24
25
- // Currenly supported Types are "reframe", "dht", "parallel", "sequential".
26
- // Reframe type allows to add other resolvers using the Reframe spec:
27
- // https://github.com/ipfs/specs/tree/main/reframe
28
- // In the future we will support "dht" and other Types here.
25
+ // Router type ID. See RouterType for more info.
26
Type RouterType
27
28
// Parameters are extra configuration that this router might need.
@@ -107,11 +104,11 @@ func (r *RouterParser) UnmarshalJSON(b []byte) error {
104
type RouterType string
105
106
const (
110
- RouterTypeReframe RouterType = "reframe"
111
- RouterTypeHTTP RouterType = "http"
112
- RouterTypeDHT RouterType = "dht"
113
- RouterTypeSequential RouterType = "sequential"
114
- RouterTypeParallel RouterType = "parallel"
107
+ RouterTypeReframe RouterType = "reframe" // More info here: https://github.com/ipfs/specs/tree/main/reframe . Actually deprecated.
108
+ RouterTypeHTTP RouterType = "http" // HTTP JSON API for delegated routing systems (IPIP-337).
109
+ RouterTypeDHT RouterType = "dht" // DHT router.
110
+ RouterTypeSequential RouterType = "sequential" // Router helper to execute several routers sequentially.
111
+ RouterTypeParallel RouterType = "parallel" // Router helper to execute several routers in parallel.
112
)
113
114
type DHTMode string