docs: update GraphQL response data docs#6997
Open
mateusz-pietras wants to merge 1 commit into
Open
Conversation
Clarify behavior of 'data' field in response documentation as independent from `errors` field.
jvh-aws
approved these changes
Jun 1, 2026
Contributor
|
Thanks a lot for the contribution |
Closed
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.
Clarify behavior of
datafield in response documentation as independent fromerrorsfieldIssue #, if available:
N/A
Description of changes:
Updates the
GraphQLResponse.datadartdoc inamplify_core. The previous comment stated thatdatawill benullwhenevererrorsis non-empty, which does not match the GraphQL response format or Amplify's decoding behavior.Per the GraphQL response format,
dataanderrorsare separate top-level fields. Field-level errors can be returned alongside a partialdatapayload (partial success). Amplify'sGraphQLResponseDecoderpreserves decodeddatawhen the server returns bothdataanderrors, for example:The updated documentation clarifies that
datamay be non-null whenerrorsis non-empty, and directs callers to checkhasErrorsbefore treating the response as fully successful.No runtime or API changes—documentation only.
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.