Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

docs: fix Router config Godoc #9528

Merged
merged 3 commits into from
Jan 5, 2023
Merged

docs: fix Router config Godoc #9528

Changes from 1 commit
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
986d0db
Docs: Refactor RouterType godocs.
ajnavarro Jan 4, 2023
11bc049
Update config/routing.go
ajnavarro Jan 5, 2023
c8406b6
Merge branch 'master' into ajnavarro/docs/fix-router-godoc
ajnavarro Jan 5, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 6 additions & 9 deletions config/routing.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,7 @@ type Routing struct {

type Router struct {

// Currenly supported Types are "reframe", "dht", "parallel", "sequential".
// Reframe type allows to add other resolvers using the Reframe spec:
// https://github.com/ipfs/specs/tree/main/reframe
// In the future we will support "dht" and other Types here.
// Router type ID. See RouterType for more info.
Type RouterType

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

const (
RouterTypeReframe RouterType = "reframe"
RouterTypeHTTP RouterType = "http"
RouterTypeDHT RouterType = "dht"
RouterTypeSequential RouterType = "sequential"
RouterTypeParallel RouterType = "parallel"
RouterTypeReframe RouterType = "reframe" // More info here: https://github.com/ipfs/specs/tree/main/reframe . Actually deprecated.
RouterTypeHTTP RouterType = "http" // HTTP JSON based API for delegated routing systems.
RouterTypeDHT RouterType = "dht" // DHT router.
RouterTypeSequential RouterType = "sequential" // Router helper to execute several routers sequentially.
RouterTypeParallel RouterType = "parallel" // Router helper to execute several routers in parallel.
)

type DHTMode string
Expand Down