Comment
Abstract¶
Comment Document¶
This is a document which provides a comment against a particular Proposal Document.
Specification¶
Catalyst Comment document is a Catalyst Signed Document, so its fully follows the structure of the Catalyst Signed Document specification.
Metadata Fields¶
A list of used Catalyst Signed Document protected header fields.
content type
:application/json
. Catalyst Signed Document content must be in JSON format.
content encoding
: Catalyst Signed Document content must be Brotli compressed.
ref
. Reference to a related Proposal Document.template
must be equal to0b8424d4-ebfd-46e3-9577-1775a69d290c
value, comment template type.
-
reply
(optional). A reference to another comment, where the comment is in reply to the referenced comment. Comments may only reply to a single other comment document. The referencedcomment
must be for the same proposalid
, but can be for a different proposalver
. -
section
(optional). Used when the comment only applies to a specific section to the document being commented upon, and not the entire document.
Content format¶
TODO
Comment Template¶
This document pr provides the template structure which a Comment must be formatted to, and validated against.
Specification¶
Catalyst Comment Template document is a Catalyst Signed Document, so its fully follows the structure of the Catalyst Signed Document specification.
Metadata Fields¶
A list of used Catalyst Signed Document protected header fields.
content type
:application/json
. Catalyst Signed Document content must be in JSON format.
content encoding
: Catalyst Signed Document content must be Brotli compressed.
Content format¶
TODO
Copyright¶
This document is licensed under CC-BY-4.0.