docs(storage): clarify upsert has no effect in uploadToSignedUrl #1915
+3
−1
Conversation
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
grdsdev
approved these changes
Dec 3, 2025
itslenny
approved these changes
Dec 3, 2025
Contributor
itslenny
left a comment
itslenny
left a comment
There was a problem hiding this comment.
I think it'd make sense to also add a note to the upsert param in FileOptions here so it shows in the tooltip when trying to set this param.
The issue is this is on FileOptions which is used in multiple places so you'd need to create a new type (e.g. SignedUploadFileOptions) that is identical but has the note to not use this property. As shown in the above screenshot I think this would be much more discoverable, but does make it an actual code change instead of just docs.
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.
Adds JSDoc note to
uploadToSignedUrl()clarifying that theupsertoption has no effect.upsertbehavior must be set when callingcreateSignedUploadUrl()instead, as the permission is encoded in the JWT token.Related #1672