|
| 1 | +--- |
| 2 | +Title: Catalyst Review Document |
| 3 | +Category: Catalyst |
| 4 | +Status: Proposed |
| 5 | +Authors: |
| 6 | + - Steven Johnson <[email protected]> |
| 7 | +Implementors: |
| 8 | + - Catalyst Fund 14 |
| 9 | +Discussions: [] |
| 10 | +Created: 2024-12-29 |
| 11 | +License: CC-BY-4.0 |
| 12 | +--- |
| 13 | + |
| 14 | +## Abstract |
| 15 | + |
| 16 | +## Review Document |
| 17 | + |
| 18 | +TODO |
| 19 | + |
| 20 | +### Specification |
| 21 | + |
| 22 | +Catalysyt Review document is a [Catalyst Signed Document], |
| 23 | +so its fully follows the structure of the [Catalyst Signed Document] specification. |
| 24 | + |
| 25 | +* [`content type`](./../signed_doc/spec.md#content-type): `application/json`. |
| 26 | + [Catalyst Signed Document content] must be in [JSON] format. |
| 27 | + |
| 28 | + ```CDDL |
| 29 | + 3 => 30 |
| 30 | + ``` |
| 31 | + |
| 32 | +* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): `"br"`. |
| 33 | + [Catalyst Signed Document content] must be [Brotli] compressed. |
| 34 | + |
| 35 | +#### Metadata Fields |
| 36 | + |
| 37 | +A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields). |
| 38 | + |
| 39 | +* [`template`](./../signed_doc/meta.md#ref-document-reference) must be equal to `ebe5d0bf-5d86-4577-af4d-008fddbe2edc` value, [review template type](#review-template). |
| 40 | + |
| 41 | + ```CDDL |
| 42 | + "template" => 37(h'ebe5d0bf5d864577af4d008fddbe2edc') |
| 43 | + ``` |
| 44 | + |
| 45 | +## Review Template |
| 46 | + |
| 47 | +TODO |
| 48 | + |
| 49 | +### Specification |
| 50 | + |
| 51 | +Catalysyt Review Template document is a [Catalyst Signed Document], |
| 52 | +so its fully follows the structure of the [Catalyst Signed Document] specification. |
| 53 | + |
| 54 | +* [`content type`](./../signed_doc/spec.md#content-type): `application/json`. |
| 55 | + [Catalyst Signed Document content] must be in [JSON] format. |
| 56 | + |
| 57 | + ```CDDL |
| 58 | + 3 => 30 |
| 59 | + ``` |
| 60 | + |
| 61 | +* [`content encoding`](./../signed_doc/spec.md#content-encoding-optional): `"br"`. |
| 62 | + [Catalyst Signed Document content] must be [Brotli] compressed. |
| 63 | + |
| 64 | +#### Metadata Fields |
| 65 | + |
| 66 | +A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields). |
| 67 | + |
| 68 | +* [`ref`](./../signed_doc/meta.md#ref-document-reference) (optional) |
| 69 | +* [`reply`](./../signed_doc/meta.md#reply-reply-reference) (optional) |
| 70 | +* [`section`](./../signed_doc/meta.md#section-section-reference) (optional) |
| 71 | +* [`collabs`](./../signed_doc/meta.md#collabs-authorized-collaborators) (optional) |
| 72 | + |
| 73 | +## Copyright |
| 74 | + |
| 75 | +This document is licensed under [CC-BY-4.0](https://creativecommons.org/licenses/by/4.0/legalcode). |
| 76 | + |
| 77 | +[Catalyst Signed Document]: ./../signed_doc/spec.md |
| 78 | +[Catalyst Signed Document content]: ./../signed_doc/spec.md#signed-object-content |
| 79 | +[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932 |
| 80 | +[JSON]: https://datatracker.ietf.org/doc/html/rfc7159 |
0 commit comments