From 81ad7621ba5c36b4fdf1362827abef6a5c44e8b7 Mon Sep 17 00:00:00 2001 From: Mr-Leshiy Date: Thu, 6 Feb 2025 11:08:07 +0200 Subject: [PATCH 1/5] update spec --- .../08_concepts/catalyst_docs/comment.md | 18 +++++++++++------- .../08_concepts/catalyst_docs/proposal.md | 14 +++++++++----- .../08_concepts/catalyst_docs/review.md | 10 ++++------ 3 files changed, 24 insertions(+), 18 deletions(-) diff --git a/docs/src/architecture/08_concepts/catalyst_docs/comment.md b/docs/src/architecture/08_concepts/catalyst_docs/comment.md index b146c2e028..667f93b320 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/comment.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/comment.md @@ -47,17 +47,21 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do ``` * [`ref`](./../signed_doc/meta.md#ref-document-reference). - Reference to a related [Proposal Document]. -* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0b8424d4-ebfd-46e3-9577-1775a69d290c` value, - [comment template type](#comment-template). + Reference to a related [Proposal Document], + which [`type`](./../signed_doc/spec.md#type) must be equal to + [proposal document `type`][Proposal Document] field value. - ```CDDL - "template" => 37(h'0b8424d4ebfd46e395771775a69d290c') - ``` +* [`template`](./../signed_doc/meta.md#ref-document-reference). + A reference to the comment template document, + which [`type`](./../signed_doc/spec.md#type) must be equal to + [comment template `type`](#comment-template) field value. * [`reply`](./../signed_doc/meta.md#reply-reply-reference) (optional). - A reference to another comment, + A reference to another comment document, where the comment is in reply to the referenced comment. + The [`type`](./../signed_doc/spec.md#type) of the replied document + must be equal to comment document `type` field value. + Comments may only reply to a single other comment document. The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id), but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver). diff --git a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md index f9639cc64d..7e11421955 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md @@ -50,12 +50,16 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do "content-type" => "br" ``` -* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `0ce8ab38-9258-4fbc-a62e-7faa6e58318f` value, - [proposal template type](#proposal-template). +* [`template`](./../signed_doc/meta.md#ref-document-reference). + A reference to the proposal template document, + which [`type`](./../signed_doc/spec.md#type) must be equal to + [proposal template `type`](#proposal-template) field value. + +* [`category_id`](./../signed_doc/meta.md#category_id) (optional). + A reference to the category document, + which [`type`](./../signed_doc/spec.md#type) must be equal to + `48c20109-362a-4d32-9bba-e0a9cf8b45be` value. - ```CDDL - "template" => 37(h'0ce8ab3892584fbca62e7faa6e58318f') - ``` #### Content format diff --git a/docs/src/architecture/08_concepts/catalyst_docs/review.md b/docs/src/architecture/08_concepts/catalyst_docs/review.md index 456bd3d69c..3ac5e9382f 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/review.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/review.md @@ -46,12 +46,10 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do "content-type" => "br" ``` -* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value, - [review template type](#review-template). - - ```CDDL - "template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc') - ``` +* [`template`](./../signed_doc/meta.md#ref-document-reference). + A reference to the comment template document, + which [`type`](./../signed_doc/spec.md#type) must be equal to + [review template `type`](#review-template) field value. #### Content format From 3d088190f850125160c614a826e882358cd10dd9 Mon Sep 17 00:00:00 2001 From: Alex Pozhylenkov Date: Thu, 6 Feb 2025 16:06:36 +0200 Subject: [PATCH 2/5] Update docs/src/architecture/08_concepts/catalyst_docs/review.md Co-authored-by: Steven Johnson --- docs/src/architecture/08_concepts/catalyst_docs/review.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/architecture/08_concepts/catalyst_docs/review.md b/docs/src/architecture/08_concepts/catalyst_docs/review.md index 3ac5e9382f..9c48564b1f 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/review.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/review.md @@ -47,7 +47,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do ``` * [`template`](./../signed_doc/meta.md#ref-document-reference). - A reference to the comment template document, + A reference to the review template document, which [`type`](./../signed_doc/spec.md#type) must be equal to [review template `type`](#review-template) field value. From 70d493752b27f900bc7e6cb3ba59963aac50d625 Mon Sep 17 00:00:00 2001 From: Mr-Leshiy Date: Thu, 6 Feb 2025 16:11:33 +0200 Subject: [PATCH 3/5] fix md --- docs/src/architecture/08_concepts/catalyst_docs/proposal.md | 1 - 1 file changed, 1 deletion(-) diff --git a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md index 7e11421955..2bb8f51a23 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md @@ -60,7 +60,6 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do which [`type`](./../signed_doc/spec.md#type) must be equal to `48c20109-362a-4d32-9bba-e0a9cf8b45be` value. - #### Content format TODO From 4546cd3b8e680d00c12d828fb38e5eb0ebc511cf Mon Sep 17 00:00:00 2001 From: Mr-Leshiy Date: Thu, 6 Feb 2025 21:10:04 +0200 Subject: [PATCH 4/5] fix --- docs/src/architecture/08_concepts/catalyst_docs/comment.md | 1 - docs/src/architecture/08_concepts/signed_doc/meta.md | 1 + 2 files changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/src/architecture/08_concepts/catalyst_docs/comment.md b/docs/src/architecture/08_concepts/catalyst_docs/comment.md index 667f93b320..c17686ad40 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/comment.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/comment.md @@ -61,7 +61,6 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do where the comment is in reply to the referenced comment. The [`type`](./../signed_doc/spec.md#type) of the replied document must be equal to comment document `type` field value. - Comments may only reply to a single other comment document. The referenced `comment` must be for the same proposal [`id`](./../signed_doc/spec.md#id), but can be for a different proposal [`ver`](./../signed_doc/spec.md#ver). diff --git a/docs/src/architecture/08_concepts/signed_doc/meta.md b/docs/src/architecture/08_concepts/signed_doc/meta.md index 539f53a79a..1344b2f8be 100644 --- a/docs/src/architecture/08_concepts/signed_doc/meta.md +++ b/docs/src/architecture/08_concepts/signed_doc/meta.md @@ -115,4 +115,5 @@ e.g. "Development & Infrastructure", "Products & Integrations". [UUID]: https://www.rfc-editor.org/rfc/rfc9562.html [CBOR]: https://datatracker.ietf.org/doc/rfc8949/ +[JSON]: https://datatracker.ietf.org/doc/html/rfc7159 [JSON Path]: https://datatracker.ietf.org/doc/html/rfc9535 From d94372a911863ed9b669a018d30cc605ace76f90 Mon Sep 17 00:00:00 2001 From: Mr-Leshiy Date: Tue, 11 Feb 2025 20:56:55 +0200 Subject: [PATCH 5/5] fix --- docs/src/architecture/08_concepts/catalyst_docs/comment.md | 4 ++-- docs/src/architecture/08_concepts/catalyst_docs/proposal.md | 4 ++-- docs/src/architecture/08_concepts/catalyst_docs/review.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/docs/src/architecture/08_concepts/catalyst_docs/comment.md b/docs/src/architecture/08_concepts/catalyst_docs/comment.md index c17686ad40..b90aa8b024 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/comment.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/comment.md @@ -43,7 +43,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` * [`ref`](./../signed_doc/meta.md#ref-document-reference). @@ -103,7 +103,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` #### Content format diff --git a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md index 2bb8f51a23..db1c80d797 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/proposal.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/proposal.md @@ -47,7 +47,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` * [`template`](./../signed_doc/meta.md#ref-document-reference). @@ -94,7 +94,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` #### Content format diff --git a/docs/src/architecture/08_concepts/catalyst_docs/review.md b/docs/src/architecture/08_concepts/catalyst_docs/review.md index 9c48564b1f..749bbdb1dc 100644 --- a/docs/src/architecture/08_concepts/catalyst_docs/review.md +++ b/docs/src/architecture/08_concepts/catalyst_docs/review.md @@ -43,7 +43,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` * [`template`](./../signed_doc/meta.md#ref-document-reference). @@ -85,7 +85,7 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do [Catalyst Signed Document content] must be [Brotli] compressed. ```CDDL - "content-type" => "br" + "content-encoding" => "br" ``` #### Content format