docs(swift): clarify partial mutation result with relationships - #8626
Merged
VarshithaPamisetty merged 1 commit intoSep 25, 2026
Merged
Conversation
harsh62
approved these changes
Sep 25, 2026
thisisabhash
approved these changes
Sep 25, 2026
VarshithaPamisetty
marked this pull request as ready for review
September 25, 2026 19:29
VarshithaPamisetty
deleted the
docs/swift-mutation-partial-relationship
branch
September 25, 2026 19:29
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
3 participants
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.
Description of changes:
A Swift mutation on a model with a relationship can return
.failure(.partial(data, errors))even though the item was created, because AppSync redacts the related object when different authorization rules apply to the related model. Developers read the failure as the write not happening, which is how this keeps getting reported.This adds a note to the Swift section of the mutate data page saying the created item is in the associated value, including the id of the related record, so the relationship can be read with a separate query. The redaction itself is already documented on the Relationships page; this adds the Swift-specific consequence where developers hit it.
Checks
yarn buildsucceeds with no errorsRefs #4127, #3913