Skip to content

Commit 5d7aa54

Browse files
Mr-Leshiystevenj
andauthored
feat(docs): Update Catalyst Signed Document specification. (#200)
* update spec * Update docs/src/architecture/08_concepts/catalyst_docs/review.md Co-authored-by: Steven Johnson <[email protected]> * fix md --------- Co-authored-by: Steven Johnson <[email protected]>
1 parent b07e9f1 commit 5d7aa54

File tree

4 files changed

+29
-24
lines changed

4 files changed

+29
-24
lines changed

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

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,21 +43,24 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4343
[Catalyst Signed Document content] must be [Brotli] compressed.
4444

4545
```CDDL
46-
"content-type" => "br"
46+
"content-encoding" => "br"
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.
6164
Comments may only reply to a single other comment document.
6265
The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id),
6366
but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver).
@@ -100,7 +103,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
100103
[Catalyst Signed Document content] must be [Brotli] compressed.
101104

102105
```CDDL
103-
"content-type" => "br"
106+
"content-encoding" => "br"
104107
```
105108

106109
#### Content format

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

Lines changed: 10 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -47,15 +47,18 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4747
[Catalyst Signed Document content] must be [Brotli] compressed.
4848

4949
```CDDL
50-
"content-type" => "br"
50+
"content-encoding" => "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.
5557

56-
```CDDL
57-
"template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f')
58-
```
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.
5962

6063
#### Content format
6164

@@ -91,7 +94,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
9194
[Catalyst Signed Document content] must be [Brotli] compressed.
9295

9396
```CDDL
94-
"content-type" => "br"
97+
"content-encoding" => "br"
9598
```
9699

97100
#### Content format

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

Lines changed: 6 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,15 +43,13 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
4343
[Catalyst Signed Document content] must be [Brotli] compressed.
4444

4545
```CDDL
46-
"content-type" => "br"
46+
"content-encoding" => "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 review 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

@@ -87,7 +85,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
8785
[Catalyst Signed Document content] must be [Brotli] compressed.
8886

8987
```CDDL
90-
"content-type" => "br"
88+
"content-encoding" => "br"
9189
```
9290

9391
#### Content format

docs/src/architecture/08_concepts/signed_doc/meta.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -115,4 +115,5 @@ e.g. "Development & Infrastructure", "Products & Integrations".
115115

116116
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html
117117
[CBOR]: https://datatracker.ietf.org/doc/rfc8949/
118+
[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
118119
[JSON Path]: https://datatracker.ietf.org/doc/html/rfc9535

0 commit comments

Comments
 (0)