Skip to content

Commit ca0396e

Browse files
ajnavarrolidel
andauthored
docs: fix Router config Godoc (#9528)
Co-authored-by: Marcin Rataj <[email protected]>
1 parent 13155e5 commit ca0396e

1 file changed

Lines changed: 6 additions & 9 deletions

File tree

config/routing.go

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,7 @@ type Routing struct {
2222

2323
type Router struct {
2424

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.
2926
Type RouterType
3027

3128
// Parameters are extra configuration that this router might need.
@@ -107,11 +104,11 @@ func (r *RouterParser) UnmarshalJSON(b []byte) error {
107104
type RouterType string
108105

109106
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.
115112
)
116113

117114
type DHTMode string

0 commit comments

Comments
 (0)