docs: comprehensive cache control documentation for Ariadne example#18
Merged
nogueira-raphael merged 1 commit intomainfrom Feb 15, 2026
Merged
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #18 +/- ##
=======================================
Coverage 71.55% 71.55%
=======================================
Files 34 34
Lines 1030 1030
Branches 163 163
=======================================
Hits 737 737
Misses 254 254
Partials 39 39 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
938fe69 to
ce94699
Compare
- Document all @CacheControl directive scenarios from Apollo Server - Add field-level and type-level definition examples - Explain inheritMaxAge usage and when to use it - Document dynamic cache hints in resolvers - Add cache behavior calculation rules (lowest maxAge, PRIVATE wins) - Explain default maxAge behavior for different field types - Add example queries with expected Cache-Control headers - Document cache invalidation patterns - Add table of contents for navigation - Translate to English
ce94699 to
1b79047
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Comprehensive update to the Ariadne example README documenting all
@cacheControldirective scenarios from Apollo Server caching documentation.Changes
@cacheControl(maxAge: 300))type User @cacheControl(maxAge: 600))inheritMaxAgeusage and when to use itset_cache_hint,private_cache,no_cache)maxAgewinsPRIVATEwins overPUBLICCache-ControlheadersCloses
Partially addresses #6 (Improve FastAPI + Ariadne example)
Reference
Based on: https://www.apollographql.com/docs/apollo-server/performance/caching/