Improve description of asPreview argument
#2879
Comments
jasonbahl
added a commit
that referenced
this issue
Aug 3, 2023
…-argument fix: increase clarity of the description of `asPreview` argument
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
What problem does this address?
The
asPreviewargument could be more clear so users know what to expect.Per feedback in #2876, there's room for improvement in the description of the
asPreviewargument.What is your proposed solution?
Update the description to something like the following:
"Whether to return the Preview Node instead of the Published Node. When the ID of a Node is provided along with asPreview being set to true, the preview node with un-published changes will be returned instead of the published node. If no preview node exists or the requestor doesn't have proper capabilities to preview, no node will be returned."
What alternatives have you considered?
No response
Additional Context
No response
The text was updated successfully, but these errors were encountered: