Skip to content

Commit 5ad69ad

Browse files
committed
docs: clean links and punctuation
1 parent b1ac1d0 commit 5ad69ad

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

src/routing/http-routing-v1.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,21 @@ order: 0
1313
tags: ['routing']
1414
---
1515

16-
"Delegated content routing" is a mechanism for IPFS implementations to use for offloading content routing to another process/server. This spec describes an HTTP API for delegated content routing.
16+
"Delegated content routing" is a mechanism for IPFS implementations to use for offloading content routing to another process/server. This specification describes an HTTP API for delegated content routing.
1717

1818
## API Specification
1919

2020
The Delegated Content Routing Routing HTTP API uses the `application/json` content type by default.
2121

22-
As such, human-readable encodings of types are preferred. This spec may be updated in the future with a compact `application/cbor` encoding, in which case compact encodings of the various types would be used.
22+
As such, human-readable encodings of types are preferred. This specification may be updated in the future with a compact `application/cbor` encoding, in which case compact encodings of the various types would be used.
2323

2424
## Common Data Types
2525

26-
- CIDs are always string-encoded using a [multibase](https://github.com/multiformats/multibase)-encoded [CIDv1](https://github.com/multiformats/cid#cidv1).
27-
- Multiaddrs are string-encoded according to the [human-readable multiaddr specification](https://github.com/multiformats/multiaddr#specification)
28-
- Peer IDs are string-encoded according [PeerID string representation specification](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#string-representation)
29-
- Multibase bytes are string-encoded according to [the Multibase spec](https://github.com/multiformats/multibase), and *should* use base64.
30-
- Timestamps are Unix millisecond epoch timestamps
26+
- CIDs are always string-encoded using a [multibase]-encoded [CIDv1].
27+
- Multiaddrs are string-encoded according to the [human-readable multiaddr specification][multiaddr].
28+
- Peer IDs are string-encoded according [PeerID string representation specification][peer-id-representation].
29+
- Multibase bytes are string-encoded according to [the Multibase spec][multibase], and SHOULD use base64.
30+
- Timestamps are Unix millisecond epoch timestamps.
3131

3232
Until required for business logic, servers should treat these types as opaque strings, and should preserve unknown JSON fields.
3333

@@ -143,7 +143,7 @@ Specification: [ipfs/specs/BITSWAP.md](https://github.com/ipfs/specs/blob/main/B
143143
}
144144
```
145145

146-
- `ID`: the [Peer ID](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md) to contact
146+
- `ID`: the [Peer ID][peer-id] to contact
147147
- `Addrs`: a list of known multiaddrs for the peer
148148
- This list may be incomplete or incorrect and should only be treated as *hints* to improve performance by avoiding extra peer lookups
149149

@@ -169,8 +169,14 @@ Specification: [ipfs/go-graphsync/blob/main/docs/architecture.md](https://github
169169
}
170170
```
171171

172-
- `ID`: the peer ID of the provider
172+
- `ID`: the [Peer ID][peer-id] of the provider
173173
- `Addrs`: a list of known multiaddrs for the provider
174174
- `PieceCID`: the CID of the [piece](https://spec.filecoin.io/systems/filecoin_files/piece/#section-systems.filecoin_files.piece) within which the data is stored
175175
- `VerifiedDeal`: whether the deal corresponding to the data is verified
176176
- `FastRetrieval`: whether the provider claims there is an unsealed copy of the data available for fast retrieval
177+
178+
[multibase]: https://github.com/multiformats/multibase
179+
[CIDv1]: https://github.com/multiformats/cid#cidv1
180+
[multiaddr]: https://github.com/multiformats/multiaddr#specification
181+
[peer-id]: https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md
182+
[peer-id-representation]: https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md#string-representation

0 commit comments

Comments
 (0)