Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

path-gateway: clarify Range should support single range #430

Merged
merged 1 commit into from
Aug 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 13 additions & 4 deletions src/http-gateways/path-gateway.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ editors:
xref:
- url
- trustless-gateway
- ipip-0402
- ipip-0412
tags: ['httpGateways', 'lowLevelHttpGateways']
order: 0
---
Expand Down Expand Up @@ -143,15 +145,22 @@ For example:

### `Range` (request header)

`Range` can be used for requesting specific byte ranges of UnixFS files and raw
`Range` can be used for requesting specific byte range of UnixFS files and raw
blocks.

Gateway implementations SHOULD be smart enough to require only the minimal DAG subset
necessary for handling the range request.

NOTE: for more advanced use cases such as partial DAG/CAR streaming, or
non-UnixFS data structures, see the `selector` query parameter
[proposal](https://github.com/ipfs/go-ipfs/issues/8769).
Gateways SHOULD support single range requests. The support of more than one
range is optional: implementation MAY decide to not support more than one range.

:::note

For more advanced use cases such as partial DAG/CAR streaming, or non-UnixFS
data structures, see `dag-scope` and `entity-bytes` from :cite[ipip-0402] and
ordered CARs from :cite[ipip-0412].

:::

### `Service-Worker` (request header)

Expand Down