Skip to content

fix(gateway): clarify cache-control of generated html on /ipfs #480

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.

Sign up for GitHub

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

Open
lidel wants to merge 3 commits into
base: main
Choose a base branch
from
Open

fix(gateway): clarify cache-control of generated html on /ipfs #480

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
5e84225
fix: clarify cache-control of generated html
lidel Jul 29, 2024
d3cdb71
chore(gw): allow best-effort cache-control on missing ttl
lidel Jul 29, 2024
7d1e29d
chore: clarify week is floor, not ceiling suggestion
lidel Nov 21, 2024
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
9 changes: 7 additions & 2 deletions src/http-gateways/path-gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -426,14 +426,19 @@ Returned directive depends on requested content path and format:

- `Cache-Control: public, max-age=29030400, immutable` MUST be returned for
every immutable resource under `/ipfs/` namespace.
- Generated `/ipfs/` responses such as UnixFS directory listings are not
byte-for-byte immutable and SHOULD have a meaningful expiration that allows
for generated responses to be updated over time. Suggested value is one week:
`public, max-age=604800, stale-while-revalidate=2678400`.

- `Cache-Control: public, max-age=<ttl>` SHOULD be returned for mutable
- `Cache-Control: public, max-age=<ttl>, stale-while-revalidate=2678400` SHOULD be returned for mutable
resources under `/ipns/{id-with-ttl}/` namespace; `max-age=<ttl>` SHOULD
indicate remaining TTL of the mutable pointer such as :cite[ipns-record] or DNSLink
TXT record.
- Implementations MAY place an upper bound on any TTL received, as
noted in Section 8 of :cite[rfc2181].
- If TTL value is unknown, implementations SHOULD not send a `Cache-Control`
- If TTL value is unknown, implementations MAY send a best-effort `Cache-Control`
informing caches and CDNs how long a stale response is acceptable.
- No matter if TTL value is known or not, implementations SHOULD always
send a [`Last-Modified`](#last-modified-response-header) header with the timestamp of the record resolution.

Expand Down