Skip to content

Commit

Permalink
Apply suggestions from code review
Browse files Browse the repository at this point in the history
Co-authored-by: Daniel Norman <[email protected]>
Co-authored-by: Andrew Gillis <[email protected]>
  • Loading branch information
3 people authored Oct 2, 2024
1 parent 616564c commit 60575a3
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions docs/concepts/ipni.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ By providing this additional layer of information, the indexer helps to speed up

### Example: finding providers via `/routing/v1`

Most of the time, IPFS implementations interact with IPNI by querying the HTTP endpoint compatible with [Delegated Routing V1 API Specification](https://specs.ipfs.tech/routing/http-routing-v1/).
Most of the time, IPFS implementations interact with the IPNI by querying the HTTP endpoint compatible with [Delegated Routing V1 API Specification](https://specs.ipfs.tech/routing/http-routing-v1/).

```plaintext
$ curl https://cid.contact/routing/v1/providers/bafybeigdyrzt5sfp7udm7hu76uh7y26nf3efuylqabf3oclgtqy55fbzdi
Expand Down Expand Up @@ -115,7 +115,7 @@ Endpoint produces human-readable JSON objects:
}
```

Each result follows [PeerSchema](https://specs.ipfs.tech/routing/http-routing-v1/#peer-schema), and is the same format as every other delegated routing endpoint in the IPFS ecosystem. This allows clients to write code once and use across all routing systems.
Each result follows [PeerSchema](https://specs.ipfs.tech/routing/http-routing-v1/#peer-schema), and is the same format as every other delegated routing endpoint in the IPFS ecosystem. This allows client code reuse across all compatible routing systems.

:::callout TIP
To start receiving results immediately, enable [streaming responses](https://specs.ipfs.tech/routing/http-routing-v1/#streaming) by passing `Accept: application/x-ndjson` HTTP Header.
Expand All @@ -131,7 +131,7 @@ Light IPFS clients may prefer to query [delegated-ipfs.dev/routing/v1](https://d

### 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.
The IPNI also provides its own HTTP API(s) which may be preferable when IPNI-specific information is desired.

To demonstrate the practical application and usage of IPNI, this section will walk through a hands-on example involving the `cid.contact` indexer tool. The `cid.contact` tool leverages IPNI to return provider record information for a given CID.

Expand Down

0 comments on commit 60575a3

Please sign in to comment.