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

fix: add /routing/v1 example to ipni.md #1931

Open
wants to merge 2 commits into
base: main
Choose a base branch
from

Conversation

lidel
Copy link
Member

@lidel lidel commented Sep 27, 2024

kubo, rainbow and helia all use /routing/v1, yet
the ipni.md document has a prominent example that hits /cid

historically, focus on /cid lead to more than one outage where only /cid was checked, but /routing/v1 did not work correctly

this PR adds a prominent example how /routing/v1 is used and why it exists, links to relevant specs, and adds some useful references, as a bare minimum to adjust perspective how IPFS uses IPNI in real world

kubo, rainbow and helia all use /routing/v1, yet
the document has a prominent example that hits /cid

this lead to more than one outage where only /cid was checked,
but /routing/v1 did not work correctly

this adds a prominent example how /routing/v1 is used and whi, links to
relevant specs, and adds some useful references, as a bare minimum
to adjust perspective how IPFS uses IPNI
@lidel lidel requested a review from 2color September 27, 2024 17:45
@lidel lidel changed the title fix: add /routing/v1 example ipni.md fix: add /routing/v1 example to ipni.md Sep 27, 2024
docs/concepts/ipni.md Outdated Show resolved Hide resolved
Copy link
Member

@2color 2color left a comment

Choose a reason for hiding this comment

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

This is helpful!


### Example: finding providers via IPNI-specific `/cid` endpoint

IPNI also provides own HTTP API(s) which may be preferable when IPNI-specific information is desired.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
IPNI also provides own HTTP API(s) which may be preferable when IPNI-specific information is desired.
IPNI also provides its own HTTP API(s) which may be preferable when IPNI-specific information is desired.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants