Skip to content

Commit 81ad762

Browse files
committed
update spec
1 parent d4c9f6a commit 81ad762

File tree

3 files changed

+24
-18
lines changed

3 files changed

+24
-18
lines changed

docs/src/architecture/08_concepts/catalyst_docs/comment.md

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,17 +47,21 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4747
```
4848

4949
* [`ref`](./../signed_doc/meta.md#ref-document-reference).
50-
Reference to a related [Proposal Document].
51-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value,
52-
[comment template type](#comment-template).
50+
Reference to a related [Proposal Document],
51+
which [`type`](./../signed_doc/spec.md#type) must be equal to
52+
[proposal document `type`][Proposal Document] field value.
5353

54-
```CDDL
55-
"template" => 37(h'0b8424d4ebfd46e395771775a69d290c')
56-
```
54+
* [`template`](./../signed_doc/meta.md#ref-document-reference).
55+
A reference to the comment template document,
56+
which [`type`](./../signed_doc/spec.md#type) must be equal to
57+
[comment template `type`](#comment-template) field value.
5758

5859
* [`reply`](./../signed_doc/meta.md#reply-reply-reference) (optional).
59-
A reference to another comment,
60+
A reference to another comment document,
6061
where the comment is in reply to the referenced comment.
62+
The [`type`](./../signed_doc/spec.md#type) of the replied document
63+
must be equal to comment document `type` field value.
64+
6165
Comments may only reply to a single other comment document.
6266
The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id),
6367
but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver).

docs/src/architecture/08_concepts/catalyst_docs/proposal.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -50,12 +50,16 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
5050
"content-type" => "br"
5151
```
5252

53-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value,
54-
[proposal template type](#proposal-template).
53+
* [`template`](./../signed_doc/meta.md#ref-document-reference).
54+
A reference to the proposal template document,
55+
which [`type`](./../signed_doc/spec.md#type) must be equal to
56+
[proposal template `type`](#proposal-template) field value.
57+
58+
* [`category_id`](./../signed_doc/meta.md#category_id) (optional).
59+
A reference to the category document,
60+
which [`type`](./../signed_doc/spec.md#type) must be equal to
61+
`48c20109-362a-4d32-9bba-e0a9cf8b45be` value.
5562

56-
```CDDL
57-
"template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
58-
```
5963

6064
#### Content format
6165

docs/src/architecture/08_concepts/catalyst_docs/review.md

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -46,12 +46,10 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4646
"content-type" => "br"
4747
```
4848

49-
* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value,
50-
[review template type](#review-template).
51-
52-
```CDDL
53-
"template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc')
54-
```
49+
* [`template`](./../signed_doc/meta.md#ref-document-reference).
50+
A reference to the comment template document,
51+
which [`type`](./../signed_doc/spec.md#type) must be equal to
52+
[review template `type`](#review-template) field value.
5553

5654
#### Content format
5755

0 commit comments

Comments
 (0)