Skip to content

docs(httpcache): document PurgeTagProviderInterface for sub-resource invalidation - #2371

Open
guillaumedelre wants to merge 4 commits into
api-platform:mainfrom
guillaumedelre:feat/http-cache-purge-tag-provider-main
Open

guillaumedelre wants to merge 4 commits into
api-platform:mainfrom
guillaumedelre:feat/http-cache-purge-tag-provider-main

Conversation

@guillaumedelre

Copy link
Copy Markdown

Summary

  • Adds a new "Invalidating Additional Tags on Mutation" section in core/performance.md
  • Documents PurgeTagProviderInterface with a concrete sub-resource collection example
  • Covers Symfony (autoconfigured or explicitly tagged service) and Laravel (automatic discovery in app/) wiring
  • States that the interface is available since API Platform 5.1, and when providers are called (built-in Doctrine ORM and MongoDB ODM persist/remove processors only)

Related to api-platform/core#7970 and api-platform/core#8123

Supersedes #2282, which targeted the 4.2 branch.

Signed-off-by: Guillaume Delré <delre.guillaume@gmail.com>
…eration methods

Replace getTagsForResource() with the three dedicated methods (getTagsForInsert,
getTagsForUpdate, getTagsForDelete) and show the parent-change invalidation use
case that motivated the split. Drop the Laravel section (out of scope).
@guillaumedelre

Copy link
Copy Markdown
Author

The Prettier failure is unrelated to this change: it comes from two invalid GraphQL snippets in core/graphql.md (empty selection sets) that Prettier 3.10 now reformats. Fixed in #2372.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant