BetaOptional BetadatasetBetadocumentBetadocumentOptional BetafieldNarrow to one field. Omit to get every comment on the document.
Optional BetaliveIndicates whether this document uses liveEdit mode.
When true, the document does not use the draft/published model and edits are applied directly to the document.
Optional BetaperspectiveOptional BetaprojectOptional BetaresourceExplicit resource to use. On an individual operation this overrides any default;
on a SanityConfig it becomes the instance's default resource. Unlike
projectId/dataset, this can also be a media library or canvas resource.
Optional BetascopeWhich of the document's comments to read.
'perspective' follows what you are viewing: a release shows that
release's comments, anything else pools draft and published.'exact' matches only the precise document id passed.'all' returns every comment on the document.'perspective' recognises a release from the {releaseName} form. A
stacked ClientPerspective array names several layers at once, with no
single release to read comments from, so it pools draft and published as
any other non-release perspective does. To read the pooled list while a
release is in view, pass a non-release perspective alongside; to name a
release yourself, pass a version id as the documentId.
A content variant is stored as a version document, so under
'perspective' its comments form a list of their own, the way a release's
do. A variant's draft and published comments are separate lists: pairing
them needs the variant's name, which its document id does not carry.
Optional BetastatusNarrow to open or resolved threads. Omit for both.
Which of a document's comments to read.