docs: warn when using defaultPopulate on collections with an upload field.
#10138
Conversation
This file contains 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
… field. This is an important note as without specifying both `filename: true` and `url: true` Payload APIs will return `url: null` for uploads.
docs: add important warning for using `defaultPopulate` on collections with an upload field.
r1tsuu
reviewed
Dec 23, 2024
Comment on lines
+140
to
+144
| <Banner type="warning"> | ||
| <strong>Important:</strong> | ||
| When using `defaultPopulate` on collections with a [Upload](/docs/fields/upload) field, it is important to specify `filename: true` and `url: true`, otherwise Payload will not be able to fetch the correct image URL and populate the URL field in your queries, instead returning `url: null`. | ||
| </Banner> | ||
|
|
There was a problem hiding this comment.
I think
on collections with a Upload field,
Is confusing as you probably mean using it on collections that have enabled uploads https://payloadcms.com/docs/upload/overview, not on upload fields.
There was a problem hiding this comment.
Yes that is what I meant, messed up the wording.
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.
When
defaultPopulateis enabled without specifyingfilename: trueandurl: truefor collections with an upload field. The upload will not have a valid URL when returned from Payload APIs and will instead be returned with a value ofnull