Skip to content

Commit 98f82db

Browse files
committed
Add a table of available document types
1 parent aa2e48f commit 98f82db

File tree

3 files changed

+28
-1
lines changed

3 files changed

+28
-1
lines changed

docs/src/architecture/08_concepts/signed_doc/.pages

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ title: Catalyst Signed Document
22
nav:
33
- Specification: spec.md
44
- Metadata Fields List: meta.md
5+
- Document Types: types.md

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

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,8 @@ a list of different metadata fields is specified.
5151

5252
Also as you can see from the specification,
5353
it is allowed to add any number of additional metadata fields, which could be specified for each `type` of document.
54-
A full list of considered additional metadata fields defined [here](./meta.md).
54+
55+
[A full list of considered additional metadata fields](./meta.md).
5556

5657
All these fields will be encoded as the [COSE] `protected` header
5758

@@ -69,6 +70,8 @@ Each Catalyst Signed Document will have a type identifier called `type`.
6970

7071
The `type` is a [UUID] V4.
7172

73+
[A full list of Catalyst supported document types]
74+
7275
#### `id`
7376

7477
Every Catalyst Signed Document will have a unique ID.
Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
2+
| [UUID] | [CBOR] | Type Description | Payload Type |
3+
| ------------------------------------ | ----------------------------------------- | ---------------------------- | --------------------------------- |
4+
| 7808d2ba-d511-40af-84e8-c0d1625fdfdc | `37(h'7808d2bad51140af84e8c0d1625fdfdc')` | Proposal Document | [Brotli] Compressed [JSON] |
5+
| 0ce8ab38-9258-4fbc-a62e-7faa6e58318f | `37(h'0ce8ab3892584fbca62e7faa6e58318f')` | Proposal Template | [Brotli] Compressed [JSON Schema] |
6+
| b679ded3-0e7c-41ba-89f8-da62a17898ea | `37(h'b679ded30e7c41ba89f8da62a17898ea')` | Comment Document | [Brotli] Compressed [JSON] |
7+
| 0b8424d4-ebfd-46e3-9577-1775a69d290c | `37(h'0b8424d4ebfd46e395771775a69d290c')` | Comment Template | [Brotli] Compressed [JSON Schema] |
8+
| e4caf5f0-098b-45fd-94f3-0702a4573db5 | `37(h'e4caf5f0098b45fd94f30702a4573db5')` | Review Document | [Brotli] Compressed [JSON] |
9+
| ebe5d0bf-5d86-4577-af4d-008fddbe2edc | `37(h'ebe5d0bf5d864577af4d008fddbe2edc')` | Review Template | [Brotli] Compressed [JSON Schema] |
10+
| 48c20109-362a-4d32-9bba-e0a9cf8b45be | `37(h'48c20109362a4d329bbae0a9cf8b45be')` | Category Parameters Document | [Brotli] Compressed [JSON] |
11+
| 65b1e8b0-51f1-46a5-9970-72cdf26884be | `37(h'65b1e8b051f146a5997072cdf26884be')` | Category Parameters Template | [Brotli] Compressed [JSON Schema] |
12+
| 0110ea96-a555-47ce-8408-36efe6ed6f7c | `37(h'0110ea96a55547ce840836efe6ed6f7c')` | Campaign Parameters Document | [Brotli] Compressed [JSON] |
13+
| 7e8f5fa2-44ce-49c8-bfd5-02af42c179a3 | `37(h'7e8f5fa244ce49c8bfd502af42c179a3')` | Campaign Parameters Template | [Brotli] Compressed [JSON Schema] |
14+
| 3e4808cc-c86e-467b-9702-d60baa9d1fca | `37(h'3e4808ccc86e467b9702d60baa9d1fca')` | Brand Parameters Document | [Brotli] Compressed [JSON] |
15+
| fd3c1735-80b1-4eea-8d63-5f436d97ea31 | `37(h'fd3c173580b14eea8d635f436d97ea31')` | Brand Parameters Template | [Brotli] Compressed [JSON Schema] |
16+
| 5e60e623-ad02-4a1b-a1ac-406db978ee48 | `37(h'5e60e623ad024a1ba1ac406db978ee48')` | Proposal Action Document | *TBD* |
17+
18+
19+
[JSON Schema]: https://json-schema.org/draft-07
20+
[JSON]: https://datatracker.ietf.org/doc/html/rfc7159
21+
[Brotli]: https://datatracker.ietf.org/doc/html/rfc7932
22+
[CBOR]: https://datatracker.ietf.org/doc/html/rfc8610
23+
[UUID]: https://www.rfc-editor.org/rfc/rfc9562.html

0 commit comments

Comments
 (0)