-
Notifications
You must be signed in to change notification settings - Fork 7
Adding first draft of incremental delivery spec artifact #67
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
calvincestari
wants to merge
8
commits into
main
Choose a base branch
from
incremental-delivery
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
9e9b707
Adding first draft of incremental delivery spec artifact
calvincestari f7ca267
Fix build errors
calvincestari d3a9b3c
Adds inline documentation to directive definitions
calvincestari 65cddb8
Add HTTP header detail
calvincestari 2188bce
Simplify Accept header value
calvincestari 64140f0
Shorten file names and index references
calvincestari 33b4062
Add index entry
calvincestari d6f0abd
Adds v0.1 spec
calvincestari File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Some comments aren't visible on the classic Files Changed page.
There are no files selected for viewing
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
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# HTTP Request Headers | ||
|
||
In order for the server to know that the client can parse the incremental delivery response format, the HTTP request must include the following header: | ||
|
||
## Accept | ||
|
||
`multipart/mixed;deferSpec=20220824` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
""" | ||
Used to imply de-prioritization, that causes the fragment to be omitted in the initial response, and delivered as a subsequent response afterward. | ||
|
||
Arguments: | ||
* `if: Boolean` | ||
* When `true` fragment may be deferred, if omitted defaults to `true`. | ||
* `label: String` | ||
* A unique label across all `@defer` and `@stream` directives in an operation. | ||
* This `label` should be used by GraphQL clients to identify the data from patch responses and associate it with the correct fragment. | ||
* If provided, the GraphQL Server must add it to the payload. | ||
""" | ||
directive @defer( | ||
label: String | ||
if: Boolean! = true | ||
) on FRAGMENT_SPREAD | INLINE_FRAGMENT | ||
|
||
""" | ||
This directive may be provided for a field of `List` type so that the backend can leverage technology such asynchronous iterators to provide a partial list in the initial response, and additional list items in subsequent responses. | ||
|
||
Arguments: | ||
* `if: Boolean` | ||
* When `true` field may be streamed, if omitted defaults to `true`. | ||
* `label: String` | ||
* A unique label across all `@defer` and `@stream` directives in an operation. | ||
* This `label` should be used by GraphQL clients to identify the data from patch responses and associate it with the correct fragments. | ||
* If provided, the GraphQL Server must add it to the payload. | ||
* `initialCount: Int` | ||
* The number of list items the server should return as part of the initial response. | ||
""" | ||
directive @stream( | ||
label: String | ||
if: Boolean! = true | ||
initialCount: Int = 0 | ||
) on FIELD |
Large diffs are not rendered by default.
Oops, something went wrong.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,7 @@ | ||
# HTTP Request Headers | ||
|
||
In order for the server to know that the client can parse the incremental delivery response format, the HTTP request must include the following header: | ||
|
||
## Accept | ||
|
||
`multipart/mixed;incrementalSpec=v0.2` |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,34 @@ | ||
""" | ||
Used to imply de-prioritization, that causes the fragment to be omitted in the initial response, and delivered as a subsequent response afterward. | ||
|
||
Arguments: | ||
* `if: Boolean` | ||
* When `true` fragment may be deferred, if omitted defaults to `true`. | ||
* `label: String` | ||
* A unique label across all `@defer` and `@stream` directives in an operation. | ||
* This `label` should be used by GraphQL clients to identify the data from patch responses and associate it with the correct fragment. | ||
* If provided, the GraphQL Server must add it to the payload. | ||
""" | ||
directive @defer( | ||
label: String | ||
if: Boolean! = true | ||
) on FRAGMENT_SPREAD | INLINE_FRAGMENT | ||
|
||
""" | ||
This directive may be provided for a field of `List` type so that the backend can leverage technology such asynchronous iterators to provide a partial list in the initial response, and additional list items in subsequent responses. | ||
|
||
Arguments: | ||
* `if: Boolean` | ||
* When `true` field may be streamed, if omitted defaults to `true`. | ||
* `label: String` | ||
* A unique label across all `@defer` and `@stream` directives in an operation. | ||
* This `label` should be used by GraphQL clients to identify the data from patch responses and associate it with the correct fragments. | ||
* If provided, the GraphQL Server must add it to the payload. | ||
* `initialCount: Int` | ||
* The number of list items the server should return as part of the initial response. | ||
""" | ||
directive @stream( | ||
label: String | ||
if: Boolean! = true | ||
initialCount: Int = 0 | ||
) on FIELD |
Large diffs are not rendered by default.
Oops, something went wrong.
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
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.
Uh oh!
There was an error while loading. Please reload this page.