Skip to content

Commit 2dbdb54

Browse files
committed
editorial touches
1 parent 828378d commit 2dbdb54

File tree

1 file changed

+8
-8
lines changed

1 file changed

+8
-8
lines changed

src/routing/http-routing-v1.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,11 @@ As such, human-readable encodings of types are preferred. This specification may
3838

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

41-
### Versioning
41+
## Versioning
4242

4343
This API uses a standard version prefix in the path, such as `/v1/...`. If a backwards-incompatible change must be made, then the version number should be increased.
4444

45-
## Content Providers API
45+
## Content Routing API
4646

4747
### `GET /routing/v1/providers/{cid}`
4848

@@ -72,11 +72,11 @@ This API uses a standard version prefix in the path, such as `/v1/...`. If a bac
7272
}
7373
```
7474

75-
Response limit: 100 providers.
75+
Responses SHOULD be limited to 100 providers. This endpoint MAY support [streaming](#streaming).
7676

77-
Each object in the `Providers` list is a record confirming to the [Peer Schema](#peer).
77+
Each object in the `Providers` list is a record conforming to the [Peer Schema](#peer).
7878

79-
## Peers API
79+
## Peer Routing API
8080

8181
### `GET /routing/v1/peers/{peer-id}`
8282

@@ -107,9 +107,9 @@ represented as a CIDv1 encoded with `libp2p-key` codec.
107107
}
108108
```
109109

110-
Response limit: 100 peer records.
110+
Responses SHOULD be limited to 100 providers. This endpoint MAY support [streaming](#streaming).
111111

112-
Each object in the `Peers` list is a record confirming to the [Peer Schema](#peer).
112+
Each object in the `Peers` list is a record conforming to the [Peer Schema](#peer).
113113

114114
## IPNS API
115115

@@ -172,7 +172,7 @@ with one result per line:
172172

173173
:::note
174174

175-
Streaming is opt-in and backwards-compatibile with clients and servers that do
175+
Streaming is opt-in and backwards-compatible with clients and servers that do
176176
not support streaming:
177177

178178
- Requests without the `Accept: application/x-ndjson` header MUST default to

0 commit comments

Comments
 (0)