update metadata fields

Author: Mr-Leshiy

docs/src/architecture/08_concepts/catalyst_voting/v2.md

@@ -21,22 +21,6 @@ so its fully follows the structure of the [Catalyst Signed Document] specificati
 
 A list of used [Catalyst Signed Document protected header fields](./../signed_doc/spec.md#signed-object-fields).
 
-```CDDL
-"brand_id" => UUID, ; UUID v4
-"campaign_id" => UUID, ; UUID v4
-"election_id" => UUID, ; UUID v4
-"category_id" => UUID, ; UUID v4
-```
-
-* `brand_id` - a unique identifier which represents a "brand" who is running the voting,
-    e.g. Catalyst, Midnight.
-* `campaign_id` - a unique identifier which defines a "campaign" of voting,
-    e.g. "treasury campaign".
-* `election_id` - a unique identifier which defines an election,
-    e.g. "Catalyst Fund 1", "Catalyst Fund 2".
-* `category_id` - a unique identifier which defines a voting category as a collection of proposals,
-    e.g. "Development & Infrastructure", "Products & Integrations".
-
 * [`content type`](./../signed_doc/spec.md#content-type): `application/cbor`.
   [Catalyst Signed Document content] must be a [CBOR] encoded.
 
@@ -51,6 +35,11 @@ A list of used [Catalyst Signed Document protected header fields](./../signed_do
   "content-type" => "br"
   ```
 
+* [`brand_id`](./../signed_doc/meta.md#brand_id).
+* [`campaign_id`](./../signed_doc/meta.md#campaign_id).
+* [`election_id`](./../signed_doc/meta.md#election_id).
+* [`category_id`](./../signed_doc/meta.md#category_id).
+
 #### Public vote
 
 For the public vote [`type`](./../signed_doc/spec.md#type) value defined as follows:

docs/src/architecture/08_concepts/signed_doc/cddl/additional_meta.cddl

@@ -5,9 +5,13 @@ additional_fields = {
   ? "reply" => ref_type,
   ? "section" => text,
   ? "collabs" => [+any],
+  ? "brand_id" => UUID, ; UUID v4
+  ? "campaign_id" => UUID, ; UUID v4
+  ? "election_id" => UUID, ; UUID v4
+  ? "category_id" => UUID, ; UUID v4
 }
 
-ref_type = UUID / [UUID, UUID]
+ref_type = UUID / [UUID, UUID] ; UUIDs v7
 ref_hash_type = [ref_type, hash-bytes]
 
 UUID = #6.37(bytes)

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

@@ -8,12 +8,17 @@
     ```
 <!-- markdownlint-enable max-one-sentence-per-line code-block-style -->
 
-* [`ref` Document Reference](#ref-document-reference)
-* [`ref-hash` Secured Document Reference](#ref-hash-secured-document-reference)
-* [`template` Template Reference](#template-template-reference)
-* [`reply` Reply Reference](#reply-reply-reference)
-* [`section` Section Reference](#section-section-reference)
-* [`collabs` Authorized Collaborators](#collabs-authorized-collaborators)
+* [Metadata Fields List](#metadata-fields-list)
+  * [`ref` Document Reference](#ref-document-reference)
+  * [`ref-hash` Secured Document Reference](#ref-hash-secured-document-reference)
+  * [`template` Template Reference](#template-template-reference)
+  * [`reply` Reply Reference](#reply-reply-reference)
+  * [`section` Section Reference](#section-section-reference)
+  * [`collabs` Authorized Collaborators](#collabs-authorized-collaborators)
+  * [`brand_id`](#brand_id)
+  * [`campaign_id`](#campaign_id)
+  * [`election_id`](#election_id)
+  * [`category_id`](#category_id)
 
 ## `ref` Document Reference
 
@@ -22,11 +27,11 @@ The purpose of the `ref` will vary depending on the document [`type`](./spec.md#
 
 The `ref` can be either a single [UUID] or a [CBOR] Array of Two [UUID].
 
-If the `ref` is a single [UUID], it is a reference to the document of that [`id`](./spec.md#id).
+If the `ref` is a single [UUID] v7, it is a reference to the document of that [`id`](./spec.md#id).
 If the `ref` is a [CBOR] array, it has the form `[<id>,<ver>]` where:
 
-* `<id>` - the [UUID] of the referenced documents [`id`](./spec.md#id).
-* `<ver>` - the [UUID] of the referenced documents [`ver`](./spec.md#ver).
+* `<id>` - the [UUID] v7 of the referenced documents [`id`](./spec.md#id).
+* `<ver>` - the [UUID] v7 of the referenced documents [`ver`](./spec.md#ver).
 
 ## `ref-hash` Secured Document Reference
 
@@ -80,3 +85,19 @@ It does NOT mean that the listed collaborators have agreed to collaborate, only
 gives them permission to.*
 
 This list can impact actions that can be performed by the `Proposal Action Document`.
+
+## `brand_id`
+
+Unique identifier [UUID] v4, which represents a "brand" who is running the voting, e.g. Catalyst, Midnight.
+
+## `campaign_id`
+
+Unique identifier [UUID] v4, which defines a "campaign" of voting, e.g. "treasury campaign".
+
+## `election_id`
+
+Unique identifier [UUID] v4, which defines an election, e.g. "Catalyst Fund 1", "Catalyst Fund 2".
+
+## `category_id`
+
+Unique identifier [UUID] v4 which defines a voting category as a collection of proposals, e.g. "Development & Infrastructure", "Products & Integrations".

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

@@ -68,7 +68,7 @@ All these fields will be encoded as the [COSE] `protected` header
 
 Each Catalyst Signed Document will have a type identifier called `type`.
 
-The `type` is a [UUID] V4.
+The `type` is a [UUID] v4.
 
 [A full list of Catalyst supported document types](./types.md)
 
@@ -81,7 +81,7 @@ However, `id` uniqueness is only guaranteed on first use.
 
 If the same `id` is used, by unauthorized publishers, the Catalyst Signed Document is invalid.
 
-The `id` is a [UUID] V7.
+The `id` is a [UUID] v7.
 
 The first time a Catalyst Signed Document is created, it will be assigned by the creator a new `id` which must
 be well constructed.
@@ -105,7 +105,7 @@ including all otherwise legitimate publications by the same author being marked
 Every Catalyst Signed Document in the system will be versioned.
 There can, and probably will, exist multiple versions of the same document.
 
-The `ver` is a [UUID] V7.
+The `ver` is a [UUID] v7.
 
 The initial `ver` assigned the first time a Catalyst Signed Document is published will be identical to the [`id`](#id).
 Subsequent versions will retain the same [`id`](#id) and will create a new `ver`,