From afdda724516da70907954593692f8e0f4f0e100e Mon Sep 17 00:00:00 2001 From: Daniel Norman <1992255+2color@users.noreply.github.com> Date: Wed, 25 Sep 2024 16:11:43 +0200 Subject: [PATCH] Update ipip-0484.md Co-authored-by: Marcin Rataj --- src/ipips/ipip-0484.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/ipips/ipip-0484.md b/src/ipips/ipip-0484.md index 7ade57b0..eac2cc98 100644 --- a/src/ipips/ipip-0484.md +++ b/src/ipips/ipip-0484.md @@ -64,7 +64,8 @@ The proposed change is to add a `?filter-protocols` parameter to the `GET /routi - Add a `?filter-protocols=` optional parameter to `GET /routing/v1/providers/{CID}` to filter providers based on the `Protocol` field of the [Peer schema] . - The `filter-protocols` parameter is a comma-separated list of transfer protocol names, e.g. `?filter-protocols=transport-bitswap`. -- Transfer protocols names should be treated as opaque strings and have a max length of 63 characters. A non-exhaustive list of transfer protocols are defined per convention in the [multicodec registry](https://github.com/multiformats/multicodec/blob/3b7b52deb31481790bc4bae984d8675bda4e0c82/table.csv#L149-L151). Implementations should not break when encountering unknown transfer protocol names. +- Transfer protocols names should be treated as opaque strings and have a max length of 63 characters. A non-exhaustive list of transfer protocols are defined per convention in the [multicodec registry](https://github.com/multiformats/multicodec/blob/3b7b52deb31481790bc4bae984d8675bda4e0c82/table.csv#L149-L151). +- Implementations MUST ignore unknown transfer protocol names. - `unknown` can be be passed to include providers whose transfer protocol is unknown, e.g. `?filter-protocols=unknown`. This allows filtering providers returned from the DHT that do not contain explicit transfer protocol information. - Providers are filtered by checking if the transfer protocol name appears in the `Protocols` array (logical OR). - If the provider doesn't match any of the passed transfer protocols, the provider is omitted from the response.