Skip to content

Commit 5aa1e46

Browse files
committed
docs: changelog entry for the routing/http
1 parent 04714d1 commit 5aa1e46

File tree

1 file changed

+15
-2
lines changed

1 file changed

+15
-2
lines changed

CHANGELOG.md

Lines changed: 15 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,11 +20,24 @@ The following emojis are used to highlight certain changes:
2020
- `blockservice.NewWritethrough` deprecated function has been removed, instead you can do `blockservice.New(..., ..., WriteThrough())` like previously.
2121
- `gateway`: a new header configuration middleware has been added to replace the existing header configuration, which can be used more generically.
2222
- `namesys` now has a `WithMaxCacheTTL` option, which allows you to define a maximum TTL that will be used for caching IPNS entries.
23+
-`routing/http`: delegated content and peer routing ([IPIP-378](https://github.com/ipfs/specs/pull/378)) has been implemented. This includes the following additions:
24+
- `client`: now includes `Provide` and `ProvidePeer` methods, which can be used to provide signed records for content routing and peer routing.
25+
- `types`: types related to the Announcement schema record have been added. A `types/iter.Filter` utility has also been added if you want to filter on top of an iterator.
2326

2427
### Changed
2528

29+
- ✨🛠 `routing/http`: delegated content and peer routing ([IPIP-378](https://github.com/ipfs/specs/pull/378)) has been implemented. This includes the following changes:
30+
- `client`: `WithProviderInfo` now accepts a third parameter, `protocols`, whose value is used when providing the peer.
31+
- `contentrouter`: the `Client` interface has been updated to reflect the changes made to the client, that is, replacing the `ProvideBitswap` method by the generic `Provide` method.
32+
- `server`: the `ContentRouter` interface now includes a `Provide` and a `ProvidePeer` functions.
33+
2634
### Removed
2735

36+
- ✨🛠 `routing/http`: delegated content and peer routing ([IPIP-378](https://github.com/ipfs/specs/pull/378)) has been implemented. This includes the following removals:
37+
- Deprecated Bitswap-schema related types and functions have been removed (e.g. `ProvideBitswap`, `BitswapRecord`, `SchemaBitswap`, `WriteProvidersRequest`, `WriteProvidersResponse`).
38+
- `server`: `ContentRouter` no longer includes `ProvideBitswap`
39+
- `contentrouter`: the content router adaptor no longer supports the previously deprecated Bitswap schema.
40+
2841
### Fixed
2942

3043
- 🛠 `boxo/gateway`: when making a trustless CAR request with the "entity-bytes" parameter, using a negative index greater than the underlying entity length could trigger reading more data than intended
@@ -57,7 +70,7 @@ The following emojis are used to highlight certain changes:
5770
### Fixed
5871

5972
* `boxo/gateway`
60-
* a panic (which is recovered) could sporadically be triggered inside a CAR request, if the right [conditions were met](https://github.com/ipfs/boxo/pull/511).
73+
* a panic (which is recovered) could sporadically be triggered inside a CAR request, if the right [conditions were met](https://github.com/ipfs/boxo/pull/511).
6174
* no longer emits `http: superfluous response.WriteHeader` warnings when an error happens.
6275

6376
## [v0.15.0]
@@ -161,7 +174,7 @@ The following emojis are used to highlight certain changes:
161174

162175
* 🛠 The `routing/http` package experienced following removals:
163176
* Server and client no longer support the experimental `Provide` method.
164-
`ProvideBitswap` is still usable, but marked as deprecated. A protocol-agnostic
177+
`ProvideBitswap` is still usable, but marked as deprecated. A protocol-agnostic
165178
provide mechanism is being worked on in [IPIP-378](https://github.com/ipfs/specs/pull/378).
166179
* Server no longer exports `FindProvidersPath` and `ProvidePath`.
167180

0 commit comments

Comments
 (0)