Skip to content

docs: make purge-cache section more precise and self-explanatory #53

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

Merged
krystiannowak merged 1 commit into from
May 18, 2026
Merged

docs: make purge-cache section more precise and self-explanatory #53

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 14 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,13 @@ aio aem edge-functions tail-logs first-function --debug

## Purge cache

Edge Function responses can be cached at the CDN layer. When cached content becomes stale due to inter-resource dependencies, you can explicitly purge it:
The `purge-cache` command purges the **Edge Function's internal cache** — it clears cached origin responses from `fetch()` calls and any data stored via the Core Cache API within your Edge Function. It does **not** purge the outer AEM CDN cache (for that, use the [CDN Cache Purge API](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/content-delivery/cdn-cache-purge)).

```
Browser → AEM CDN (CDN Cache) → AEM Edge Functions (Fetch Cache + Core Cache) → Origin
↑
purge-cache targets this layer
```

```
# Purge by surrogate key
Expand All @@ -238,7 +244,13 @@ aio aem edge-functions purge-cache first-function -k my-key --soft
| `--soft` / `-s` | Perform a soft purge (retain stale entries, reduce origin load) |
| `--debug` / `-d` | Show debug information including API endpoint |

Surrogate keys are set on Edge Function responses via the `Surrogate-Key` header. For more information on caching and purging, see the [AEM Edge Functions documentation](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/developing/edge-functions).
**What gets purged:**
- **Fetch cache entries** — origin responses cached when your Edge Function calls `fetch()`. Surrogate keys for these come from the origin's `Surrogate-Key` response header.
- **Core Cache API entries** — arbitrary data stored via the Core Cache or Simple Cache APIs. Surrogate keys for these are assigned programmatically when writing to the cache.

> **Note:** The `Surrogate-Key` header you set on your Edge Function's *outgoing* response to the browser controls the *outer CDN cache* (purged via the CDN Cache Purge API), not the inner fetch cache targeted by this command.

For more information on caching and purging, see the [AEM Edge Functions documentation](https://experienceleague.adobe.com/en/docs/experience-manager-cloud-service/content/implementing/developing/edge-functions).

## CI/CD Setup

Expand Down
Loading