Skip to content
New issue

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

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

Already on GitHub? Sign in to your account

docs: clarify Gateway.ExposeRoutingAPI #10337

Merged
merged 2 commits into from
Feb 9, 2024

Conversation

lidel
Copy link
Member

@lidel lidel commented Feb 8, 2024

The way I see /routing/v1 in Kubo is that it returns only results that other Kubo (or Helia) instance would find useful.

In that framing, limiting results to actionable routing results, and skipping things we know won't work, such as graphsync providers is a feature, not a bug.

If we are ok with this, and document it (this PR), we can close #10195.
I think we should document it even if we want to implement pass-through in the future.

Thoughts @aschmahmann @2color @hacdias ?

@lidel lidel added topic/docs Documentation skip/changelog This change does NOT require a changelog entry labels Feb 8, 2024
@lidel lidel requested a review from a team as a code owner February 8, 2024 19:57
Copy link
Member

@hacdias hacdias left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it makes sense to limit it in Kubo. There's no point on keeping all the records around in Kubo when there's nothing Kubo can do with them.

Someguy is then the alternative, and I think it matches well the philosophy of: Kubo shouldn't be always used for every single situation.

docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
docs/config.md Outdated Show resolved Hide resolved
@hacdias hacdias merged commit 68f9556 into master Feb 9, 2024
@hacdias hacdias deleted the docs/clarify-routing-v1-filtering branch February 9, 2024 15:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
skip/changelog This change does NOT require a changelog entry topic/docs Documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Routing-v1 gateway endpoint not returning enough information
3 participants