Comment
A signed comment on a document version, threaded through threadRoot and replyParent, with a body that is a tree of comment blocks.

Extends

type
Blob type tag, always `Comment`.
Commentoptional
signer
Public key of the account or device that signed the blob.
inherited
sig
Signature over the canonical DAG-CBOR of the blob with `sig` set to 64 zero bytes.
inherited
ts
When the signer says the blob was made, in Unix milliseconds; not checked against real time.
inherited
id
TSID of the comment being replaced; present only on an edit or a tombstone.
optional
capability
Deprecated and ignored; some old comment blobs still carry it.
optional
space
Space of the commented document; omitted when it equals the signer.
optional
path
Path of the commented document within `space`.
optional
version
CIDs of the document heads the author was looking at; empty means the document at this path.
of optional
threadRoot
CID of the first comment of the thread; present on every reply.
optional
replyParent
CID of the comment this one replies to; omitted when it equals `threadRoot`.
optional
body
The comment's content as a list of comment blocks; an empty body is a tombstone.
of
visibility
Empty for a public comment or `Private`, usually copied from the target document.
optional

A comment is a signed note on a document version. It is a snapshot blob: each edit publishes a whole new blob, and an empty body is a tombstone. The blob names its target (space and path, with space omitted when it equals the signer) and the document version the author saw. A reply carries the thread's first comment in threadRoot and the comment it answers in replyParent, which is omitted when it equals the root. id appears only on an edit or a tombstone and holds the TSID of the comment being replaced. body is a list of comment blocks. capability is deprecated and ignored; some old blobs still carry it.

A comment's identity is <author>/<tsid>, where the TSID of the first version is derived from the blob's bytes. Comments are not permission-checked: anyone can comment on anything. A comment carries its own visibility. Comments covers threads, block and range comments, citations and mentions.

See also

    Comments: threads, block and range comments, citations and mentions.

    block/comment: the blocks inside a comment body.

    blob: the signed envelope.

    visibility: public and private comments.

    Privacy: who can read a private comment.

Do you like what you are reading? Subscribe to receive updates.

Unsubscribe anytime