Skip to content

Commit 204257f

Browse files
jwaldripclaude
andcommitted
docs: clarify @defer/@stream are draft/RFC, not finalized spec
The incremental delivery directives are still in the RFC stage and not yet part of the finalized GraphQL specification. Updated documentation to make this clear and link to the actual RFC. Co-Authored-By: Claude Opus 4.5 <noreply@anthropic.com>
1 parent d18d7ff commit 204257f

File tree

2 files changed

+5
-2
lines changed

2 files changed

+5
-2
lines changed

CHANGELOG.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,8 @@
44

55
### Features
66

7-
* **spec:** Add `@defer` and `@stream` directives for incremental delivery ([#1377](https://github.com/absinthe-graphql/absinthe/pull/1377))
7+
* **draft-spec:** Add `@defer` and `@stream` directives for incremental delivery ([#1377](https://github.com/absinthe-graphql/absinthe/pull/1377))
8+
- **Note:** These directives are still in draft/RFC stage and not yet part of the finalized GraphQL specification
89
- Split GraphQL responses into initial + incremental payloads
910
- Configure via `Absinthe.Pipeline.Incremental.enable/2`
1011
- Resource limits (max concurrent streams, memory, duration)

guides/incremental-delivery.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# Incremental Delivery
22

3+
> **Note:** The `@defer` and `@stream` directives are currently in draft/RFC stage and not yet part of the finalized GraphQL specification. The implementation follows the [Incremental Delivery RFC](https://github.com/graphql/graphql-spec/blob/main/rfcs/DeferStream.md) and may change as the specification evolves.
4+
35
GraphQL's incremental delivery allows responses to be sent in multiple parts, reducing initial response time and improving user experience. Absinthe supports this through the `@defer` and `@stream` directives.
46

57
## Overview
@@ -480,4 +482,4 @@ Existing queries work without changes. To add incremental delivery:
480482
- [Subscriptions](subscriptions.md) for real-time data
481483
- [Dataloader](dataloader.md) for efficient data fetching
482484
- [Telemetry](telemetry.md) for observability
483-
- [GraphQL Incremental Delivery Spec](https://graphql.org/blog/2020-12-08-defer-stream)
485+
- [GraphQL Incremental Delivery RFC](https://github.com/graphql/graphql-spec/blob/main/rfcs/DeferStream.md)

0 commit comments

Comments
 (0)