Skip to content

Commit

Permalink
docs(changelog) ipip-412
Browse files Browse the repository at this point in the history
  • Loading branch information
lidel committed Jul 13, 2023
1 parent 64244db commit b52d913
Showing 1 changed file with 21 additions and 5 deletions.
26 changes: 21 additions & 5 deletions docs/changelogs/v0.22.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

- [Overview](#overview)
- [πŸ”¦ Highlights](#-highlights)
- [Gateway: support for `order=` and `dups=` parameter (IPIP-412)](#gateway-support-for-order-and-dups-parameter-ipip-412)
- [Gateway: support for `order=` and `dups=` parameters (IPIP-412)](#gateway-support-for-order-and-dups-parameters-ipip-412)
- [`ipfs name publish` now supports V2 only IPNS records](#ipfs-name-publish-now-supports-v2-only-ipns-records)
- [πŸ“ Changelog](#-changelog)
- [πŸ‘¨β€πŸ‘©β€πŸ‘§β€πŸ‘¦ Contributors](#-contributors)
Expand All @@ -15,11 +15,27 @@

### πŸ”¦ Highlights

#### Gateway: support for `order=` and `dups=` parameter (IPIP-412)
#### Gateway: support for `order=` and `dups=` parameters (IPIP-412)

The gateway now supports optional CAR parameters via the `Accept` header, as
specified in [IPIP-412](https://github.com/ipfs/specs/pull/412). By default,
order is DFS and there are no duplicates.
The updated [`boxo/gateway` library](https://github.com/ipfs/boxo/tree/main/gateway)
introduces support for ordered CAR responses through the inclusion of optional
CAR content type parameters: `order=dfs` and `dups=y|n` from
[IPIP-412](https://github.com/ipfs/specs/pull/412).

Previously, Kubo already provided CARs in DFS order without duplicate blocks.
With the implementation of IPIP-412, this behavior is now explicitly defined
rather than implied.

In the absence of `dups` or `order` in `Accept` request reader, the default CAR
response will have the `Content-Type: application/vnd.ipld.car; version=1; order=dfs; dups=n`
and the same blocks as Kubo 0.21.

Kubo 0.22 still only supports DFS block ordering (`order=dfs`). However, it is
now possible to request a DFS CAR stream with duplicate blocks by opting in via
`Accept: application/vnd.ipld.car; order=dfs; dups=y`. This opt-in feature can be
beneficial for memory-constrained clients and IoT devices, as it allows for
streaming large DAGs without the need to store all previously encountered
blocks in memory.

#### `ipfs name publish` now supports V2 only IPNS records

Expand Down

0 comments on commit b52d913

Please sign in to comment.