Skip to content

Docs: Update cache status descriptions and examples for async stale-while-revalidate#28613

Merged
pedrosousa merged 3 commits intocloudflare:productionfrom
smarsh-cf:sam/async-swr-docs-followup
Feb 26, 2026
Merged

Docs: Update cache status descriptions and examples for async stale-while-revalidate#28613
pedrosousa merged 3 commits intocloudflare:productionfrom
smarsh-cf:sam/async-swr-docs-followup

Conversation

@smarsh-cf
Copy link
Contributor

Summary

Follow-up to #28577 (async stale-while-revalidate). That PR updates the changelog, revalidation.mdx, cache-control.mdx (note), and default-cache-behavior.mdx. This PR covers the remaining pages that still describe the old synchronous revalidation behaviour.

Changes

cache/concepts/cache-responses.mdx

  • REVALIDATED: reframed as the synchronous validation path — the request waited for origin before being served. Notes that with async SWR most revalidations now return UPDATING or HIT, and that REVALIDATED is now only seen when stale-while-revalidate is absent or blocking directives (must-revalidate, no-cache with OCC enabled) prevent stale serving.
  • UPDATING: removes the misleading "typically only seen for very popular cached resources" qualifier. Now explains it as the expected status during async stale-while-revalidate revalidation.

cache/concepts/cache-control.mdx

  • Updates the stale-while-revalidate example description to remove "initial synchronous revalidation" language and replace it with accurate async framing.

cache/concepts/retention-vs-freshness.mdx

  • Updates the closing paragraph to distinguish between the async (SWR) and synchronous revalidation paths, with a link to the revalidation concept page.

Dependency

The links to /cache/concepts/revalidation/#asynchronous-revalidation added in cache-responses.mdx depend on the anchor introduced in #28577. This PR should be merged after or alongside that one.

…r async SWR

- REVALIDATED: reframe as the synchronous validation path, now only seen
  without stale-while-revalidate or when must-revalidate/no-cache (with
  OCC enabled) prevents stale serving
- UPDATING: remove misleading 'very popular resources' qualifier; explain
  it as the expected status during async stale-while-revalidate revalidation
- cache-control example: remove 'initial synchronous revalidation' language
- retention-vs-freshness: update revalidation paragraph to distinguish
  async (SWR) and synchronous paths

Companion to cloudflare#28577
@smarsh-cf smarsh-cf requested review from a team and angelampcosta as code owners February 26, 2026 10:06
@github-actions github-actions bot added product:cache Issues or PRs related to Cache size/s labels Feb 26, 2026
pedrosousa noted on cloudflare#28577 that synchronous revalidation is still the
live behaviour for Enterprise zones not yet migrated, so past tense is
factually incorrect for those users. Also scope the situations where
REVALIDATED is seen to explicitly include unmigraded Enterprise zones.
@pedrosousa pedrosousa enabled auto-merge (squash) February 26, 2026 10:36
@pedrosousa pedrosousa disabled auto-merge February 26, 2026 10:37
@pedrosousa pedrosousa enabled auto-merge (squash) February 26, 2026 10:41
@pedrosousa pedrosousa merged commit 89d5fb7 into cloudflare:production Feb 26, 2026
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

product:cache Issues or PRs related to Cache size/s

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants