Skip to content

Commit dd86eb3

Browse files
lidelhsanjuan
andcommitted
fix: use kebab-case for query parameter naming
ref: #476 (comment) Co-authored-by: Hector Sanjuan <[email protected]>
1 parent 4bdfa84 commit dd86eb3

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

src/ipips/ipip-0476.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -50,8 +50,8 @@ This IPIP introduces a new "DHT Routing API" section to the Delegated Routing V1
5050

5151
#### Query Parameters
5252

53-
- `closerThan` (optional): A peer ID represented as a CIDv1 encoded with `libp2p-key` codec
54-
- Returned peer records must be closer to `peer-id` than `closerThan`
53+
- `closer-than` (optional): A peer ID represented as a CIDv1 encoded with `libp2p-key` codec
54+
- Returned peer records must be closer to `peer-id` than `closer-than`
5555
- If omitted, the routing implementation should use its own peer ID
5656
- `count` (optional): Number of peer records to return
5757
- Minimum 1, maximum 100, default 20

src/routing/http-routing-v1.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -246,16 +246,16 @@ The content body must be a [`application/vnd.ipfs.ipns-record`][application/vnd.
246246

247247
## DHT Routing API
248248

249-
### `GET /routing/v1/dht/closest/peers/{peer-id}?[closerThan]&[count]`
249+
### `GET /routing/v1/dht/closest/peers/{peer-id}`
250250

251251
#### Path Parameters
252252

253253
- `peer-id` is a [Peer ID](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md) represented as a CIDv1 encoded with `libp2p-key` codec.
254254

255255
#### Query Parameters
256256

257-
- `closerThan` is an optional [Peer ID](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md) represented as a CIDv1 encoded with `libp2p-key` codec.
258-
- Returned peer records must be closer to `peer-id` than `closerThan`.
257+
- `closer-than` is an optional [Peer ID](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md) represented as a CIDv1 encoded with `libp2p-key` codec.
258+
- Returned peer records must be closer to `peer-id` than `closer-than`.
259259
- If omitted the routing implementation should use its own [Peer ID](https://github.com/libp2p/specs/blob/master/peer-ids/peer-ids.md).
260260
- `count` is an optional number that specifies how many peer records the requester desires.
261261
- Minimum 1, maximum 100, default 20.

0 commit comments

Comments
 (0)