Skip to content

Commit 82b1b5b

Browse files
docs: Update @defer documentation (#6751)
* Update copy * Apply changes from AI Style Review * Apply suggestion from AI Style Review * Apply suggestion from @phryneas * Add suggestion from Martin Co-authored-by: Martin Bonnin <[email protected]>
1 parent fd1ce3c commit 82b1b5b

File tree

1 file changed

+4
-4
lines changed

1 file changed

+4
-4
lines changed

docs/source/fetching/defer.mdx

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,13 +3,13 @@ title: 'Using the @defer directive in Apollo Kotlin'
33
description: 'Fetch slower schema fields asynchronously'
44
---
55

6-
<ExperimentalFeature>
6+
<Note>
77

8-
**The `@defer` directive is currently [experimental](https://www.apollographql.com/docs/resources/product-launch-stages/#experimental-features) in Apollo Kotlin.** If you have feedback on it, please let us know via [GitHub issues](https://github.com/apollographql/apollo-kotlin/issues/new?assignees=&labels=Type%3A+Bug&template=bug_report.md) or in the [Kotlin Slack community](https://slack.kotl.in/).
8+
The incremental delivery format used by `@defer` [isn't yet standardized](https://github.com/graphql/defer-stream-wg). Apollo Kotlin supports [the format implemented by Apollo Router](https://www.apollographql.com/docs/graphos/routing/operations/defer#specification-status), which is described in this [specification](https://specs.apollo.dev/incremental/v0.1/).
99

10-
</ExperimentalFeature>
10+
</Note>
1111

12-
Apollo Kotlin provides experimental support of [the `@defer` directive](https://github.com/graphql/graphql-wg/blob/main/rfcs/DeferStream.md), which enables your queries to receive data for specific fields asynchronously. This is helpful whenever some fields in a query take much longer to resolve than the others.
12+
The [`@defer` directive](https://github.com/graphql/graphql-wg/blob/main/rfcs/DeferStream.md) enables your queries to receive data for specific fields incrementally, instead of receiving all field data at the same time. This is helpful when some fields in a query take much longer to resolve than others.
1313

1414
For example, let's say we're building a social media application that can quickly fetch a user's basic profile information, but retrieving that user's friends takes longer. If we include _all_ of those fields in a single query, we want to be able to display the profile information as soon as it's available, instead of waiting for the friend fields to resolve.
1515

0 commit comments

Comments
 (0)