Clarify dynamic zone fragment populate syntax#3233
Open
Akash5908 wants to merge 1 commit into
Open
Conversation
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
pwizla
changed the title
pwizla
changed the title
pwizla
changed the title
pwizla
added
pr: chore
source: CMS
contribution
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
2 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
This PR improves and clarifies the documentation for dynamic zone fragment population (using the on syntax) in the Document Service API and REST API documentation.
What does it do?
Clarifies in the Document Service API
populate.md
that standard populate queries (like populate: '*' or populate: ['dzName']) only fetch default scalar fields of components, and explains that fragment population via the on property is required to retrieve nested relations, media, or nested components.
Updates the REST API reference
populate-select.md
to clearly differentiate between scalar-only populate vs. component-specific nested populate using on.
Updates the REST API guide
understanding-populate.md
to explain the concept behind why standard/regular populates do not fetch nested relations/media inside component templates and how fragment population solves it.
Why is it needed? Users frequently face issues where relations or media fields nested inside components of dynamic zones do not load when doing a standard populate query. The previous documentation did not clearly explain that regular populates only fetch component scalars and that the fragment on syntax must be used to populate these nested fields.
Related issue(s)/PR(s)
Fixes #1386