Update caching docs to include federation support. #5536
Merged
Conversation
This file contains 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
glasser
approved these changes
Jul 23, 2021
| @@ -292,6 +290,46 @@ query GetReaderBookTitle { | |||
| } | |||
| ``` | |||
|
|
|||
| ## Using with federation | |||
|
|
|||
| When using [Apollo Federation](https://www.apollographql.com/docs/federation), the `@cacheControl` directive and `CacheControlScope` enum may be defined in a subgraph's schema. An Apollo Server-based subgraph will calculate and set the cache hint for the response that it sends to the gateway as it would for a non-federated Apollo Server sending a response to a client. The gateway will then calculate the cache hint for the overall response based on the most restrictive settings among all of the responses received from the subgraphs involved in query plan execution. | |||
There was a problem hiding this comment.
We should merge this PR once the appropriate federation and gateway PRs are released, and we should include the minimum versions of federation and gateway required to support this.
There was a problem hiding this comment.
For the minimum versions, do you think they should be included directly in the AS3 docs or in a new section in the federation docs?
There was a problem hiding this comment.
I think it would be great to have new docs on the federation site (or at least a link to here) — are you interested in writing them? I think we should also include here the minimum versions.
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
This PR updates the docs page on caching to include directions on how to use the
@cacheControldirective and AS3's new cache control features with federation. The related changes to federation will be merged into that repo with this PR:apollographql/federation#870