From 2832f6b21cb59a7b6e7fa6fd9deb986aecb01aa9 Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 15:43:06 +0300 Subject: [PATCH 1/9] fix(specs): update ver field validation specification per #502 - Add all 4 validation rules to ver field validation: 1. Version must be >= ID 2. First version requirement (moved from id validation) 3. Version increment rule 4. Document type consistency rule - Move versioning rule from id to ver validation - Update id validation to describe timestamp-based validation Closes #502 --- .../signed_doc/src/validator/rules/ver/mod.rs | 9 +- specs/definitions/signed_docs/metadata.cue | 5 +- .../definitions/signed_docs/metadata_ver.cue | 5 +- specs/signed_doc.json | 98 +++++++++---------- 4 files changed, 63 insertions(+), 54 deletions(-) diff --git a/rust/signed_doc/src/validator/rules/ver/mod.rs b/rust/signed_doc/src/validator/rules/ver/mod.rs index fb5b48fb7a2..2926c8b1e14 100644 --- a/rust/signed_doc/src/validator/rules/ver/mod.rs +++ b/rust/signed_doc/src/validator/rules/ver/mod.rs @@ -10,8 +10,13 @@ use crate::{CatalystSignedDocument, providers::CatalystSignedDocumentProvider}; pub(crate) struct VerRule; impl VerRule { - /// Validates document `ver` field on the timestamps: - /// 1. document `ver` cannot be smaller than document `id` field + /// Validates document `ver` field according to the following rules: + /// 1. Document `ver` cannot be smaller than document `id` field + /// 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist + /// 3. When a document with the same `id` already exists, the new document's `ver` must be greater + /// than the latest known submitted version for that `id` + /// 4. When a document with the same `id` already exists, the new document's `type` must be the + /// same as the latest known submitted document's `type` for that `id` pub(crate) async fn check( &self, doc: &CatalystSignedDocument, diff --git a/specs/definitions/signed_docs/metadata.cue b/specs/definitions/signed_docs/metadata.cue index 3ffc598ec02..c244c27151b 100644 --- a/specs/definitions/signed_docs/metadata.cue +++ b/specs/definitions/signed_docs/metadata.cue @@ -139,8 +139,9 @@ _allMetadataNames: or([ timestamp of when the document was created. """ validation: """ - IF `ver` does not == `id` then a document with - `id` and `ver` being equal *MUST* exist. + The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. + * If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. """ } diff --git a/specs/definitions/signed_docs/metadata_ver.cue b/specs/definitions/signed_docs/metadata_ver.cue index ec6e1c89803..11ba9fb7bce 100644 --- a/specs/definitions/signed_docs/metadata_ver.cue +++ b/specs/definitions/signed_docs/metadata_ver.cue @@ -44,7 +44,10 @@ _ver_description_sequenced: """ format: "Document Ver" description: string | *_ver_description_versioned validation: """ - The document version must always be >= the document ID. + 1. The document version must always be >= the document ID. + 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. + 3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. + 4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. """ } } diff --git a/specs/signed_doc.json b/specs/signed_doc.json index 8308574949a..6ee19d7df96 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -732,7 +732,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -783,7 +783,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -857,7 +857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -905,7 +905,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -986,7 +986,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1040,7 +1040,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1114,7 +1114,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1167,7 +1167,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1248,7 +1248,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1302,7 +1302,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1376,7 +1376,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1429,7 +1429,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1507,7 +1507,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1560,7 +1560,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1633,7 +1633,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1684,7 +1684,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1771,7 +1771,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1827,7 +1827,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1920,7 +1920,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1976,7 +1976,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2097,7 +2097,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2155,7 +2155,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2229,7 +2229,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2284,7 +2284,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2362,7 +2362,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2417,7 +2417,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2580,7 +2580,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2640,7 +2640,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2717,7 +2717,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2784,7 +2784,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2857,7 +2857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2912,7 +2912,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2990,7 +2990,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3045,7 +3045,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3123,7 +3123,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3174,7 +3174,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3245,7 +3245,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3305,7 +3305,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3445,7 +3445,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3504,7 +3504,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3572,7 +3572,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3623,7 +3623,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3708,7 +3708,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3766,7 +3766,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3834,7 +3834,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3887,7 +3887,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -9397,7 +9397,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "IF `ver` does not == `id` then a document with \n`id` and `ver` being equal *MUST* exist." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -9497,7 +9497,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents either:\n\n* when a document changes over time, such as\n\twith a new version of a particular document that supersedes an \n\tearlier one.\n* when a new document in a sequence of documents is produced.\n\t\nBecause the most common use `ver` is a new version of the same document\nthis is to be assumed unless the document specifies its representing\na sequence of documents.", "format": "Document Ver", "required": "yes", - "validation": "The document version must always be >= the document ID." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." } }, "order": [ @@ -9624,4 +9624,4 @@ "type": "object" } } -} +} \ No newline at end of file From 6a5edb7b17564b5a9340cfa65253f19f9a61c5da Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 15:59:05 +0300 Subject: [PATCH 2/9] fix(docs): add missing newline at end of signed_doc.json --- specs/signed_doc.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/signed_doc.json b/specs/signed_doc.json index 6ee19d7df96..083b99ff3f8 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -9624,4 +9624,4 @@ "type": "object" } } -} \ No newline at end of file +} From 262f169516d8344e59d5b713ecbf5c83322712de Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 16:23:23 +0300 Subject: [PATCH 3/9] fix(docs): improve formatting of ver field validation rules in documentation --- rust/signed_doc/src/validator/rules/ver/mod.rs | 11 ++++++----- 1 file changed, 6 insertions(+), 5 deletions(-) diff --git a/rust/signed_doc/src/validator/rules/ver/mod.rs b/rust/signed_doc/src/validator/rules/ver/mod.rs index 2926c8b1e14..6e087e63f3d 100644 --- a/rust/signed_doc/src/validator/rules/ver/mod.rs +++ b/rust/signed_doc/src/validator/rules/ver/mod.rs @@ -12,11 +12,12 @@ pub(crate) struct VerRule; impl VerRule { /// Validates document `ver` field according to the following rules: /// 1. Document `ver` cannot be smaller than document `id` field - /// 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist - /// 3. When a document with the same `id` already exists, the new document's `ver` must be greater - /// than the latest known submitted version for that `id` - /// 4. When a document with the same `id` already exists, the new document's `type` must be the - /// same as the latest known submitted document's `type` for that `id` + /// 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal + /// *MUST* exist + /// 3. When a document with the same `id` already exists, the new document's `ver` + /// must be greater than the latest known submitted version for that `id` + /// 4. When a document with the same `id` already exists, the new document's `type` + /// must be the same as the latest known submitted document's `type` for that `id` pub(crate) async fn check( &self, doc: &CatalystSignedDocument, From 0e76864674fb14bc54afb4c7c44fa8262a17ad34 Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 16:36:04 +0300 Subject: [PATCH 4/9] fix(docs): update ID and version validation rules in signed document metadata - Refine ID validation to include timestamp thresholds for future and past limits. - Enhance version validation with detailed rules for versioning consistency and type matching. - Ensure clarity and consistency across documentation for signed documents. --- .../08_concepts/signed_doc/docs/brand_parameters.md | 12 +++++++----- .../docs/brand_parameters_form_template.md | 12 +++++++----- .../signed_doc/docs/campaign_parameters.md | 12 +++++++----- .../docs/campaign_parameters_form_template.md | 12 +++++++----- .../signed_doc/docs/category_parameters.md | 12 +++++++----- .../docs/category_parameters_form_template.md | 12 +++++++----- .../signed_doc/docs/comment_moderation_action.md | 12 +++++++----- .../08_concepts/signed_doc/docs/contest_ballot.md | 10 +++++++--- .../signed_doc/docs/contest_ballot_checkpoint.md | 12 +++++++----- .../signed_doc/docs/contest_delegation.md | 12 +++++++----- .../signed_doc/docs/contest_parameters.md | 12 +++++++----- .../docs/contest_parameters_form_template.md | 12 +++++++----- .../signed_doc/docs/presentation_template.md | 12 +++++++----- .../08_concepts/signed_doc/docs/proposal.md | 12 +++++++----- .../08_concepts/signed_doc/docs/proposal_comment.md | 12 +++++++----- .../docs/proposal_comment_form_template.md | 12 +++++++----- .../signed_doc/docs/proposal_form_template.md | 12 +++++++----- .../signed_doc/docs/proposal_moderation_action.md | 12 +++++++----- .../signed_doc/docs/proposal_submission_action.md | 12 +++++++----- .../08_concepts/signed_doc/docs/rep_nomination.md | 12 +++++++----- .../signed_doc/docs/rep_nomination_form_template.md | 12 +++++++----- .../08_concepts/signed_doc/docs/rep_profile.md | 12 +++++++----- .../signed_doc/docs/rep_profile_form_template.md | 12 +++++++----- .../architecture/08_concepts/signed_doc/metadata.md | 10 +++++++--- 24 files changed, 168 insertions(+), 116 deletions(-) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md index e13e6565df2..b3e0a2e4397 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md @@ -86,10 +86,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -104,7 +103,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md index 55d779c5146..1663f898048 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ## Payload diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md index a057c974708..e1f16e27e5d 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md @@ -87,10 +87,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -105,7 +104,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md index d6f93043cb7..814a619f298 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md index 145d8d6e10e..e22cab40276 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md @@ -87,10 +87,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -105,7 +104,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md index 1fe27ac3f83..8fa359959c5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md index bd6815845b0..60263061b1e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md @@ -77,10 +77,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -95,7 +94,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md index a02b128552a..4d630e101bf 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md @@ -88,8 +88,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. ### [`ver`](../metadata.md#ver) @@ -106,7 +107,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`revocations`](../metadata.md#revocations) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md index 67fa9028462..6dfab4288d5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md @@ -110,10 +110,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -128,7 +127,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md index 79f78070f52..8370543dfce 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md @@ -147,10 +147,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -165,7 +164,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md index 6d59052a17a..65c84b5c57e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md @@ -87,10 +87,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -105,7 +104,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md index ea1a291fa1a..d0fd203b124 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md index 6def7261a0c..57c5b03cf79 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md @@ -89,10 +89,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -107,7 +106,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md index 3e89103c9da..f7319c41572 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md @@ -95,10 +95,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -113,7 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md index 56aabc28882..5ac4163be94 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md @@ -79,10 +79,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -97,7 +96,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md index 2f9fe0a7dc9..c8071ab8200 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md index 8a6f993e11e..530317ab619 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md index 5578ca798ce..379b62cc76b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md @@ -77,10 +77,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -95,7 +94,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md index 7478940b2b4..19e91633829 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md @@ -103,10 +103,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -121,7 +120,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md index e2868956686..58503cd3731 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md @@ -121,10 +121,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -139,7 +138,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md index 36d9954ae20..49c00138115 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md index a17a7e8db8e..fb42deb47e6 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md @@ -76,10 +76,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -94,7 +93,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md index 60d79a62394..d349104753b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md @@ -91,10 +91,9 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation -IF [`ver`](../metadata.md#ver) does not == [`id`](../metadata.md#id) then a document with -[`id`](../metadata.md#id) and [`ver`](../metadata.md#ver) being equal *MUST* exist. - -### [`ver`](../metadata.md#ver) +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. | Parameter | Value | @@ -109,7 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] #### [`ver`](../metadata.md#ver) Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md index 291180a659f..d16d8077b8b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/metadata.md +++ b/docs/src/architecture/08_concepts/signed_doc/metadata.md @@ -175,8 +175,9 @@ timestamp of when the document was created. #### `id` Validation -IF [`ver`](metadata.md#ver) does not == [`id`](metadata.md#id) then a document with -[`id`](metadata.md#id) and [`ver`](metadata.md#ver) being equal *MUST* exist. +The document ID validation is performed based on timestamp thresholds: +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. ### `ver` @@ -202,7 +203,10 @@ a sequence of documents. #### `ver` Validation -The document version must always be >= the document ID. +1. The document version must always be >= the document ID. +2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. ### `ref` From ca4d4e13a2f6cab0148b4f23d4d2a5b2ec30aa35 Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 16:46:52 +0300 Subject: [PATCH 5/9] fix(docs): enhance ID and version validation formatting in signed document metadata - Improve formatting for ID and version validation rules across multiple documentation files. - Ensure consistency in the presentation of validation criteria for better readability. - Update the signed_doc.json specification to reflect the new formatting standards. --- .../signed_doc/docs/brand_parameters.md | 13 ++- .../docs/brand_parameters_form_template.md | 13 ++- .../signed_doc/docs/campaign_parameters.md | 13 ++- .../docs/campaign_parameters_form_template.md | 13 ++- .../signed_doc/docs/category_parameters.md | 13 ++- .../docs/category_parameters_form_template.md | 13 ++- .../docs/comment_moderation_action.md | 13 ++- .../signed_doc/docs/contest_ballot.md | 13 ++- .../docs/contest_ballot_checkpoint.md | 13 ++- .../signed_doc/docs/contest_delegation.md | 13 ++- .../signed_doc/docs/contest_parameters.md | 13 ++- .../docs/contest_parameters_form_template.md | 13 ++- .../signed_doc/docs/presentation_template.md | 13 ++- .../08_concepts/signed_doc/docs/proposal.md | 13 ++- .../signed_doc/docs/proposal_comment.md | 13 ++- .../docs/proposal_comment_form_template.md | 13 ++- .../signed_doc/docs/proposal_form_template.md | 13 ++- .../docs/proposal_moderation_action.md | 13 ++- .../docs/proposal_submission_action.md | 13 ++- .../signed_doc/docs/rep_nomination.md | 13 ++- .../docs/rep_nomination_form_template.md | 13 ++- .../signed_doc/docs/rep_profile.md | 13 ++- .../docs/rep_profile_form_template.md | 13 ++- .../08_concepts/signed_doc/metadata.md | 13 ++- specs/signed_doc.json | 96 +++++++++---------- 25 files changed, 264 insertions(+), 144 deletions(-) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md index b3e0a2e4397..284250899db 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md @@ -87,8 +87,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -105,8 +107,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -216,3 +220,4 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md index 1663f898048..5b56336a996 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ## Payload @@ -157,3 +161,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md index e1f16e27e5d..742cf9ece3c 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md @@ -88,8 +88,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -106,8 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -245,3 +249,4 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md index 814a619f298..63731b1246f 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -185,3 +189,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md index e22cab40276..ba5fd30f7ff 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md @@ -88,8 +88,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -106,8 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -245,3 +249,4 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md index 8fa359959c5..697422feb5c 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -185,3 +189,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md index 60263061b1e..0ddad254ef7 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md @@ -78,8 +78,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -96,8 +98,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -178,3 +182,4 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md index 4d630e101bf..8440939bee6 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md @@ -89,8 +89,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. ### [`ver`](../metadata.md#ver) @@ -109,8 +111,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`revocations`](../metadata.md#revocations) @@ -500,3 +504,4 @@ Only the original author can update and sign a new version of documents. [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md index 6dfab4288d5..3123dd2b0c3 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md @@ -111,8 +111,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -129,8 +131,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -533,3 +537,4 @@ Only the original author can update and sign a new version of documents. [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md index 8370543dfce..7452f5fa385 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md @@ -148,8 +148,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -166,8 +168,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -379,3 +383,4 @@ Only the original author can update and sign a new version of documents. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md index 65c84b5c57e..708d74ed4f9 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md @@ -88,8 +88,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -106,8 +108,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -247,3 +251,4 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md index d0fd203b124..5981b94e0de 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -187,3 +191,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md index 57c5b03cf79..4d5824ed52e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md @@ -90,8 +90,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -108,8 +110,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -273,3 +277,4 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md index f7319c41572..043575892cf 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md @@ -96,8 +96,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -114,8 +116,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -259,3 +263,4 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md index 5ac4163be94..f1cd6af8c44 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md @@ -80,8 +80,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -98,8 +100,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -298,3 +302,4 @@ Only the original author can update and sign a new version of documents. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md index c8071ab8200..cd9d554866d 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -187,3 +191,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md index 530317ab619..4b570444554 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -187,3 +191,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md index 379b62cc76b..9b08cba87ed 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md @@ -78,8 +78,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -96,8 +98,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -178,3 +182,4 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md index 19e91633829..108adab489b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md @@ -104,8 +104,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -122,8 +124,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -339,3 +343,4 @@ of the referenced document specified by the 'ref' metadata field. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md index 58503cd3731..728c12627c9 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md @@ -122,8 +122,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -140,8 +142,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) @@ -300,3 +304,4 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md index 49c00138115..2794af34ecb 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -185,3 +189,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md index fb42deb47e6..cea257107e1 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md @@ -77,8 +77,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -95,8 +97,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) @@ -213,3 +217,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md index d349104753b..4f01bc17b9b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md @@ -92,8 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. | Parameter | Value | @@ -110,8 +112,10 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) @@ -185,3 +189,4 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 + diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md index d16d8077b8b..233baab649e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/metadata.md +++ b/docs/src/architecture/08_concepts/signed_doc/metadata.md @@ -176,8 +176,10 @@ timestamp of when the document was created. #### `id` Validation The document ID validation is performed based on timestamp thresholds: -* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. -* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. +* If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. +* If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. ### `ver` @@ -205,8 +207,10 @@ a sequence of documents. 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. -3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. -4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. +3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. +4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. ### `ref` @@ -636,3 +640,4 @@ classDiagram [RFC9562-V4]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-4 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC9562]: https://www.rfc-editor.org/rfc/rfc9562.html + diff --git a/specs/signed_doc.json b/specs/signed_doc.json index 083b99ff3f8..ff727e6b862 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -732,7 +732,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -783,7 +783,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -857,7 +857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -905,7 +905,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -986,7 +986,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1040,7 +1040,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1114,7 +1114,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1167,7 +1167,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1248,7 +1248,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1302,7 +1302,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1376,7 +1376,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1429,7 +1429,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1507,7 +1507,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1560,7 +1560,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1633,7 +1633,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1684,7 +1684,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1771,7 +1771,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1827,7 +1827,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1920,7 +1920,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1976,7 +1976,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2097,7 +2097,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2155,7 +2155,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2229,7 +2229,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2284,7 +2284,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2362,7 +2362,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2417,7 +2417,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2580,7 +2580,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2640,7 +2640,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2717,7 +2717,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2784,7 +2784,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2857,7 +2857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2912,7 +2912,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2990,7 +2990,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3045,7 +3045,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3123,7 +3123,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3174,7 +3174,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3245,7 +3245,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3305,7 +3305,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3445,7 +3445,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3504,7 +3504,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3572,7 +3572,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3623,7 +3623,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3708,7 +3708,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3766,7 +3766,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3834,7 +3834,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3887,7 +3887,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -9397,7 +9397,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -9497,7 +9497,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents either:\n\n* when a document changes over time, such as\n\twith a new version of a particular document that supersedes an \n\tearlier one.\n* when a new document in a sequence of documents is produced.\n\t\nBecause the most common use `ver` is a new version of the same document\nthis is to be assumed unless the document specifies its representing\na sequence of documents.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." } }, "order": [ From 73ae874b0e0d7f0594549a0a87122fbf02210c43 Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 17:09:42 +0300 Subject: [PATCH 6/9] fix(docs): enhance formatting of ID validation rules in signed document metadata - Improve formatting for ID validation rules across multiple documentation files to enhance readability. - Ensure consistent presentation of timestamp threshold criteria for better clarity. - Update the signed_doc.json specification to reflect the new formatting standards. --- .../signed_doc/docs/brand_parameters.md | 2 +- .../docs/brand_parameters_form_template.md | 6 +-- .../signed_doc/docs/campaign_parameters.md | 2 +- .../docs/campaign_parameters_form_template.md | 2 +- .../signed_doc/docs/category_parameters.md | 2 +- .../docs/category_parameters_form_template.md | 2 +- .../docs/comment_moderation_action.md | 2 +- .../signed_doc/docs/contest_ballot.md | 2 +- .../docs/contest_ballot_checkpoint.md | 2 +- .../signed_doc/docs/contest_delegation.md | 2 +- .../signed_doc/docs/contest_parameters.md | 2 +- .../docs/contest_parameters_form_template.md | 2 +- .../signed_doc/docs/presentation_template.md | 2 +- .../08_concepts/signed_doc/docs/proposal.md | 2 +- .../signed_doc/docs/proposal_comment.md | 2 +- .../docs/proposal_comment_form_template.md | 2 +- .../signed_doc/docs/proposal_form_template.md | 2 +- .../docs/proposal_moderation_action.md | 2 +- .../docs/proposal_submission_action.md | 2 +- .../signed_doc/docs/rep_nomination.md | 2 +- .../docs/rep_nomination_form_template.md | 2 +- .../signed_doc/docs/rep_profile.md | 2 +- .../docs/rep_profile_form_template.md | 2 +- .../08_concepts/signed_doc/metadata.md | 2 +- specs/definitions/signed_docs/metadata.cue | 7 ++- .../definitions/signed_docs/metadata_ver.cue | 6 ++- specs/signed_doc.json | 48 +++++++++---------- 27 files changed, 59 insertions(+), 54 deletions(-) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md index 284250899db..612567e1a03 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md @@ -87,6 +87,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -220,4 +221,3 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md index 5b56336a996..3cae3cae4b3 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md @@ -92,10 +92,11 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the - current time. + current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the - current time. + current time. | Parameter | Value | @@ -161,4 +162,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md index 742cf9ece3c..8b4e45d5d8d 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -249,4 +250,3 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md index 63731b1246f..38542714fe5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md index ba5fd30f7ff..3a2c02423b9 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -249,4 +250,3 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md index 697422feb5c..5be206e4b89 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md index 0ddad254ef7..7b8df7bfeb6 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md @@ -78,6 +78,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -182,4 +183,3 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md index 8440939bee6..0fc4ce8ce34 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md @@ -89,6 +89,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -504,4 +505,3 @@ Only the original author can update and sign a new version of documents. [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md index 3123dd2b0c3..5c7ab7915bb 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md @@ -111,6 +111,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -537,4 +538,3 @@ Only the original author can update and sign a new version of documents. [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8949]: https://www.rfc-editor.org/rfc/rfc8949.html [RFC8610]: https://www.rfc-editor.org/rfc/rfc8610 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md index 7452f5fa385..9cb05a06c1a 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md @@ -148,6 +148,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -383,4 +384,3 @@ Only the original author can update and sign a new version of documents. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md index 708d74ed4f9..9f3a344e761 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -251,4 +252,3 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md index 5981b94e0de..4841a1e7947 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md index 4d5824ed52e..8656b2ec1b0 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md @@ -90,6 +90,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -277,4 +278,3 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md index 043575892cf..7d705b38333 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md @@ -96,6 +96,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -263,4 +264,3 @@ of the previous submitted document's version. [RFC9052-HeaderParameters]: https://www.rfc-editor.org/rfc/rfc8152#section-3.1 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md index f1cd6af8c44..0ef8f8ed80a 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md @@ -80,6 +80,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -302,4 +303,3 @@ Only the original author can update and sign a new version of documents. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md index cd9d554866d..a8de9682cfd 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md index 4b570444554..2708a6709c8 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -191,4 +192,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md index 9b08cba87ed..637ebcc1333 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md @@ -78,6 +78,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -182,4 +183,3 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md index 108adab489b..55d548f6d68 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md @@ -104,6 +104,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -343,4 +344,3 @@ of the referenced document specified by the 'ref' metadata field. [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC8259]: https://www.rfc-editor.org/rfc/rfc8259.html - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md index 728c12627c9..24dd9c84d84 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md @@ -122,6 +122,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -304,4 +305,3 @@ Only the original author can update and sign a new version of documents. [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [IPFS-CID]: https://docs.ipfs.tech/concepts/content-addressing/#what-is-a-cid [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md index 2794af34ecb..9fe284eb42f 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md index cea257107e1..5747496ce4a 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md @@ -77,6 +77,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -217,4 +218,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md index 4f01bc17b9b..a148cd6a3b5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -189,4 +190,3 @@ Only the original author can update and sign a new version of documents. [JSON Schema-2020-12]: https://json-schema.org/draft/2020-12 [CC-BY-4.0]: https://creativecommons.org/licenses/by/4.0/legalcode [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 - diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md index 233baab649e..d8983e7da6e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/metadata.md +++ b/docs/src/architecture/08_concepts/signed_doc/metadata.md @@ -176,6 +176,7 @@ timestamp of when the document was created. #### `id` Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -640,4 +641,3 @@ classDiagram [RFC9562-V4]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-4 [RFC9562-V7]: https://www.rfc-editor.org/rfc/rfc9562.html#name-uuid-version-7 [RFC9562]: https://www.rfc-editor.org/rfc/rfc9562.html - diff --git a/specs/definitions/signed_docs/metadata.cue b/specs/definitions/signed_docs/metadata.cue index c244c27151b..ba2a753c79b 100644 --- a/specs/definitions/signed_docs/metadata.cue +++ b/specs/definitions/signed_docs/metadata.cue @@ -140,8 +140,11 @@ _allMetadataNames: or([ """ validation: """ The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. - * If `past_threshold` is configured, the document `id` cannot be too far in the past from the current time. + + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the + current time. + * If `past_threshold` is configured, the document `id` cannot be too far in the past from the + current time. """ } diff --git a/specs/definitions/signed_docs/metadata_ver.cue b/specs/definitions/signed_docs/metadata_ver.cue index 11ba9fb7bce..1b5d21829cb 100644 --- a/specs/definitions/signed_docs/metadata_ver.cue +++ b/specs/definitions/signed_docs/metadata_ver.cue @@ -46,8 +46,10 @@ _ver_description_sequenced: """ validation: """ 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. - 3. When a document with the same `id` already exists, the new document's `ver` must be greater than the latest known submitted version for that `id`. - 4. When a document with the same `id` already exists, the new document's `type` must be the same as the latest known submitted document's `type` for that `id`. + 3. When a document with the same `id` already exists, the new document's `ver` must be greater than + the latest known submitted version for that `id`. + 4. When a document with the same `id` already exists, the new document's `type` must be the same as + the latest known submitted document's `type` for that `id`. """ } } diff --git a/specs/signed_doc.json b/specs/signed_doc.json index ff727e6b862..65575ba7f2f 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -732,7 +732,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -857,7 +857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -986,7 +986,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1114,7 +1114,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1248,7 +1248,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1376,7 +1376,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1507,7 +1507,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1633,7 +1633,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1771,7 +1771,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1920,7 +1920,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2097,7 +2097,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2229,7 +2229,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2362,7 +2362,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2580,7 +2580,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2717,7 +2717,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2857,7 +2857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2990,7 +2990,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3123,7 +3123,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3245,7 +3245,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3445,7 +3445,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3572,7 +3572,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3708,7 +3708,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3834,7 +3834,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -9397,7 +9397,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", From 404ce1579ad3cf30ab7b51f66041e11af1d7bf01 Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 17:51:18 +0300 Subject: [PATCH 7/9] fix(docs): standardize formatting of ID validation rules in signed document metadata - Refine formatting for ID validation rules across multiple documentation files to enhance readability and consistency. - Ensure timestamp threshold criteria are clearly presented for both future and past limits. - Update the signed_doc.json specification to reflect the improved formatting standards. --- .../signed_doc/docs/brand_parameters.md | 5 +- .../docs/brand_parameters_form_template.md | 9 +- .../signed_doc/docs/campaign_parameters.md | 5 +- .../docs/campaign_parameters_form_template.md | 5 +- .../signed_doc/docs/category_parameters.md | 5 +- .../docs/category_parameters_form_template.md | 5 +- .../docs/comment_moderation_action.md | 5 +- .../signed_doc/docs/contest_ballot.md | 5 +- .../docs/contest_ballot_checkpoint.md | 5 +- .../signed_doc/docs/contest_delegation.md | 5 +- .../signed_doc/docs/contest_parameters.md | 5 +- .../docs/contest_parameters_form_template.md | 5 +- .../signed_doc/docs/presentation_template.md | 5 +- .../08_concepts/signed_doc/docs/proposal.md | 5 +- .../signed_doc/docs/proposal_comment.md | 5 +- .../docs/proposal_comment_form_template.md | 5 +- .../signed_doc/docs/proposal_form_template.md | 5 +- .../docs/proposal_moderation_action.md | 5 +- .../docs/proposal_submission_action.md | 5 +- .../signed_doc/docs/rep_nomination.md | 5 +- .../docs/rep_nomination_form_template.md | 5 +- .../signed_doc/docs/rep_profile.md | 5 +- .../docs/rep_profile_form_template.md | 5 +- .../08_concepts/signed_doc/metadata.md | 9 +- specs/definitions/signed_docs/metadata.cue | 25 +++-- .../definitions/signed_docs/metadata_ver.cue | 10 +- specs/signed_doc.json | 96 +++++++++---------- 27 files changed, 117 insertions(+), 142 deletions(-) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md index 612567e1a03..19214b8440e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md @@ -87,7 +87,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -109,9 +108,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md index 3cae3cae4b3..0957e2ce57e 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md @@ -92,11 +92,10 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the - current time. +current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the - current time. +current time. | Parameter | Value | @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ## Payload diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md index 8b4e45d5d8d..63030bdea11 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md @@ -88,7 +88,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -110,9 +109,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md index 38542714fe5..c6bf9f4555b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md index 3a2c02423b9..afcd0765833 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md @@ -88,7 +88,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -110,9 +109,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md index 5be206e4b89..e012dc172e3 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md index 7b8df7bfeb6..0037f6ea572 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md @@ -78,7 +78,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -100,9 +99,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md index 0fc4ce8ce34..355d4813342 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md @@ -89,7 +89,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -113,9 +112,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`revocations`](../metadata.md#revocations) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md index 5c7ab7915bb..b978c0c20eb 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md @@ -111,7 +111,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -133,9 +132,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md index 9cb05a06c1a..a3f23806caa 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md @@ -148,7 +148,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -170,9 +169,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md index 9f3a344e761..7235d2d6ffe 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md @@ -88,7 +88,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -110,9 +109,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md index 4841a1e7947..484047315b0 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md index 8656b2ec1b0..7a4dac432b9 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md @@ -90,7 +90,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -112,9 +111,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md index 7d705b38333..467a4087cf9 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md @@ -96,7 +96,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -118,9 +117,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md index 0ef8f8ed80a..e62b85bafa8 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md @@ -80,7 +80,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -102,9 +101,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md index a8de9682cfd..a203ef9fc42 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md index 2708a6709c8..d31ce6c4518 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md index 637ebcc1333..fd53114a6ce 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md @@ -78,7 +78,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -100,9 +99,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md index 55d548f6d68..abfb6a56cb7 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md @@ -104,7 +104,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -126,9 +125,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md index 24dd9c84d84..1253f070e54 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md @@ -122,7 +122,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -144,9 +143,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`ref`](../metadata.md#ref) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md index 9fe284eb42f..7d05abda940 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md index 5747496ce4a..73d2e2658c5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md @@ -77,7 +77,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -99,9 +98,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`template`](../metadata.md#template) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md index a148cd6a3b5..b5fa58aaac8 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md @@ -92,7 +92,6 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the @@ -114,9 +113,9 @@ The first version of the document must set [`ver`](../metadata.md#ver) == [`id`] 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### [`parameters`](../metadata.md#parameters) diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md index d8983e7da6e..0de8afcee5b 100644 --- a/docs/src/architecture/08_concepts/signed_doc/metadata.md +++ b/docs/src/architecture/08_concepts/signed_doc/metadata.md @@ -176,11 +176,10 @@ timestamp of when the document was created. #### `id` Validation The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the - current time. +current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the - current time. +current time. ### `ver` @@ -209,9 +208,9 @@ a sequence of documents. 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. +the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. +the latest known submitted document's `type` for that `id`. ### `ref` diff --git a/specs/definitions/signed_docs/metadata.cue b/specs/definitions/signed_docs/metadata.cue index ba2a753c79b..a621332f0aa 100644 --- a/specs/definitions/signed_docs/metadata.cue +++ b/specs/definitions/signed_docs/metadata.cue @@ -1,5 +1,5 @@ // Signed Document Definitions -// +// // Metadata Types and Constraints @extern(embed) package signed_docs @@ -135,36 +135,35 @@ _allMetadataNames: or([ format: "Document Id" description: """ Document ID, created the first time the document is created. - This must be a properly created UUIDv7 which contains the + This must be a properly created UUIDv7 which contains the timestamp of when the document was created. """ validation: """ The document ID validation is performed based on timestamp thresholds: - * If `future_threshold` is configured, the document `id` cannot be too far in the future from the - current time. + current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the - current time. + current time. """ } ref: { description: """ - Reference to a Linked Document or Documents. - This is the primary hierarchical reference to a related document. + Reference to a Linked Document or Documents. + This is the primary hierarchical reference to a related document. If a reference is defined as required, there must be at least 1 reference specified. Some documents allow multiple references, and they are documented as required. The document reference serves two purposes: - + 1. It ensures that the document referenced by an ID/Version is not substituted. In other words, that the document intended to be referenced, is actually referenced. 2. It Allows the document to be unambiguously located in decentralized storage systems. - + There can be any number of Document Locations in any reference. The currently defined locations are: - + * `cid` : A CBOR Encoded IPLD Content Identifier ( AKA an IPFS CID ). * Others may be added when further storage mechanisms are defined. @@ -186,7 +185,7 @@ _allMetadataNames: or([ template: { description: "Reference to the template used to create and/or validate this document." validation: """ - In addition to the validation performed for `Document Reference` type fields, + In addition to the validation performed for `Document Reference` type fields, The document payload is not valid if it does not validate completely against the referenced template. """ } @@ -196,7 +195,7 @@ _allMetadataNames: or([ Reference to a Comment document type being referred to. """ validation: """ - In addition to the validation performed for `Document Reference` type fields, + In addition to the validation performed for `Document Reference` type fields, The `ref` of the `reply` document must be the same as the original comment document. """ @@ -246,7 +245,7 @@ _allMetadataNames: or([ This allows for an entire document and any/all published versions to be revoked. A new version of the document that is published after this, may reinstate prior - document versions, by not listing them as revoked. + document versions, by not listing them as revoked. However, any document where revocations was set `true` can never be reinstated. """ validation: """ diff --git a/specs/definitions/signed_docs/metadata_ver.cue b/specs/definitions/signed_docs/metadata_ver.cue index 1b5d21829cb..f5a141da36b 100644 --- a/specs/definitions/signed_docs/metadata_ver.cue +++ b/specs/definitions/signed_docs/metadata_ver.cue @@ -1,5 +1,5 @@ // Signed Document Definitions -// +// // Metadata Types and Constraints // `ver` @extern(embed) @@ -16,10 +16,10 @@ _ver_description_complete: """ `ver` represents either: * when a document changes over time, such as - with a new version of a particular document that supersedes an + with a new version of a particular document that supersedes an earlier one. * when a new document in a sequence of documents is produced. - + Because the most common use `ver` is a new version of the same document this is to be assumed unless the document specifies its representing a sequence of documents. @@ -47,9 +47,9 @@ _ver_description_sequenced: """ 1. The document version must always be >= the document ID. 2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist. 3. When a document with the same `id` already exists, the new document's `ver` must be greater than - the latest known submitted version for that `id`. + the latest known submitted version for that `id`. 4. When a document with the same `id` already exists, the new document's `type` must be the same as - the latest known submitted document's `type` for that `id`. + the latest known submitted document's `type` for that `id`. """ } } diff --git a/specs/signed_doc.json b/specs/signed_doc.json index 65575ba7f2f..613cef8adf6 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -732,7 +732,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -783,7 +783,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -857,7 +857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -905,7 +905,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -986,7 +986,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1040,7 +1040,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1114,7 +1114,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1167,7 +1167,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1248,7 +1248,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1302,7 +1302,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1376,7 +1376,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1429,7 +1429,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1507,7 +1507,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1560,7 +1560,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1633,7 +1633,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1684,7 +1684,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1771,7 +1771,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1827,7 +1827,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -1920,7 +1920,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1976,7 +1976,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2097,7 +2097,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2155,7 +2155,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2229,7 +2229,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2284,7 +2284,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2362,7 +2362,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2417,7 +2417,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2580,7 +2580,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2640,7 +2640,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2717,7 +2717,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2784,7 +2784,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2857,7 +2857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2912,7 +2912,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -2990,7 +2990,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3045,7 +3045,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3123,7 +3123,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3174,7 +3174,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3245,7 +3245,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3305,7 +3305,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3445,7 +3445,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3504,7 +3504,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3572,7 +3572,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3623,7 +3623,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3708,7 +3708,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3766,7 +3766,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -3834,7 +3834,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3887,7 +3887,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents new versions of the same document as it changes over time.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "notes": [], @@ -9397,7 +9397,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\n current time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\n current time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -9497,7 +9497,7 @@ "description": "The unique version of the document.\nThe first version of the document must set `ver` == `id`\n\n`ver` represents either:\n\n* when a document changes over time, such as\n\twith a new version of a particular document that supersedes an \n\tearlier one.\n* when a new document in a sequence of documents is produced.\n\t\nBecause the most common use `ver` is a new version of the same document\nthis is to be assumed unless the document specifies its representing\na sequence of documents.", "format": "Document Ver", "required": "yes", - "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\n the latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\n the latest known submitted document's `type` for that `id`." + "validation": "1. The document version must always be >= the document ID.\n2. IF `ver` does not == `id` then a document with `id` and `ver` being equal *MUST* exist.\n3. When a document with the same `id` already exists, the new document's `ver` must be greater than\nthe latest known submitted version for that `id`.\n4. When a document with the same `id` already exists, the new document's `type` must be the same as\nthe latest known submitted document's `type` for that `id`." } }, "order": [ From 03886668efad57ceeb6f501de3c62361d05ec6ec Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 18:20:48 +0300 Subject: [PATCH 8/9] fix(docs): enhance formatting of ID validation rules in signed document metadata - Standardize the presentation of ID validation rules across multiple documentation files to improve readability. - Add missing newlines for better separation of criteria related to timestamp thresholds for future and past limits. - Update the signed_doc.json specification to reflect the improved formatting standards. --- .../signed_doc/docs/brand_parameters.md | 5 +- .../docs/brand_parameters_form_template.md | 1 + .../signed_doc/docs/campaign_parameters.md | 1 + .../docs/campaign_parameters_form_template.md | 1 + .../signed_doc/docs/category_parameters.md | 1 + .../docs/category_parameters_form_template.md | 1 + .../docs/comment_moderation_action.md | 1 + .../signed_doc/docs/contest_ballot.md | 1 + .../docs/contest_ballot_checkpoint.md | 1 + .../signed_doc/docs/contest_delegation.md | 1 + .../signed_doc/docs/contest_parameters.md | 1 + .../docs/contest_parameters_form_template.md | 1 + .../signed_doc/docs/presentation_template.md | 1 + .../08_concepts/signed_doc/docs/proposal.md | 1 + .../signed_doc/docs/proposal_comment.md | 1 + .../docs/proposal_comment_form_template.md | 1 + .../signed_doc/docs/proposal_form_template.md | 1 + .../docs/proposal_moderation_action.md | 1 + .../docs/proposal_submission_action.md | 1 + .../signed_doc/docs/rep_nomination.md | 1 + .../docs/rep_nomination_form_template.md | 1 + .../signed_doc/docs/rep_profile.md | 1 + .../docs/rep_profile_form_template.md | 1 + .../08_concepts/signed_doc/metadata.md | 1 + specs/signed_doc.json | 48 +++++++++---------- 25 files changed, 50 insertions(+), 26 deletions(-) diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md index 19214b8440e..58fb0a6bffd 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters.md @@ -87,10 +87,11 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the - current time. +current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the - current time. +current time. | Parameter | Value | diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md index 0957e2ce57e..222f169f0dc 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/brand_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md index 63030bdea11..64437da2c03 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md index c6bf9f4555b..7e1e3477ec5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/campaign_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md index afcd0765833..5ef4d7eb14f 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md index e012dc172e3..4d8d3951297 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/category_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md index 0037f6ea572..4bbf19b7240 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/comment_moderation_action.md @@ -78,6 +78,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md index 355d4813342..ff6b6572439 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot.md @@ -89,6 +89,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md index b978c0c20eb..d86f4eb8968 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_ballot_checkpoint.md @@ -111,6 +111,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md index a3f23806caa..4658f56f4a7 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_delegation.md @@ -148,6 +148,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md index 7235d2d6ffe..7b80092347d 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters.md @@ -88,6 +88,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md index 484047315b0..fbb5d6407f6 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/contest_parameters_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md index 7a4dac432b9..1a6f52556c0 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/presentation_template.md @@ -90,6 +90,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md index 467a4087cf9..83d126cad33 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md @@ -96,6 +96,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md index e62b85bafa8..eb83cb2b2b8 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment.md @@ -80,6 +80,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md index a203ef9fc42..bc1f78f3f21 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_comment_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md index d31ce6c4518..6fa9bbd90a5 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md index fd53114a6ce..60a75245886 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_moderation_action.md @@ -78,6 +78,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md index abfb6a56cb7..e1825fa3225 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/proposal_submission_action.md @@ -104,6 +104,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md index 1253f070e54..274d6b61eac 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination.md @@ -122,6 +122,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md index 7d05abda940..abc3d582272 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_nomination_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md index 73d2e2658c5..25ba17869d3 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile.md @@ -77,6 +77,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md index b5fa58aaac8..74c5ef5c774 100644 --- a/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md +++ b/docs/src/architecture/08_concepts/signed_doc/docs/rep_profile_form_template.md @@ -92,6 +92,7 @@ timestamp of when the document was created. #### [`id`](../metadata.md#id) Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/docs/src/architecture/08_concepts/signed_doc/metadata.md b/docs/src/architecture/08_concepts/signed_doc/metadata.md index 0de8afcee5b..dc0c30d5ca4 100644 --- a/docs/src/architecture/08_concepts/signed_doc/metadata.md +++ b/docs/src/architecture/08_concepts/signed_doc/metadata.md @@ -176,6 +176,7 @@ timestamp of when the document was created. #### `id` Validation The document ID validation is performed based on timestamp thresholds: + * If `future_threshold` is configured, the document `id` cannot be too far in the future from the current time. * If `past_threshold` is configured, the document `id` cannot be too far in the past from the diff --git a/specs/signed_doc.json b/specs/signed_doc.json index 613cef8adf6..e060176c78a 100644 --- a/specs/signed_doc.json +++ b/specs/signed_doc.json @@ -732,7 +732,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -857,7 +857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -986,7 +986,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1114,7 +1114,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1248,7 +1248,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1376,7 +1376,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1507,7 +1507,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1633,7 +1633,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1771,7 +1771,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -1920,7 +1920,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2097,7 +2097,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2229,7 +2229,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2362,7 +2362,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2580,7 +2580,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2717,7 +2717,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2857,7 +2857,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -2990,7 +2990,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3123,7 +3123,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3245,7 +3245,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3445,7 +3445,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3572,7 +3572,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3708,7 +3708,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -3834,7 +3834,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", @@ -9397,7 +9397,7 @@ "description": "Document ID, created the first time the document is created.\nThis must be a properly created UUIDv7 which contains the \ntimestamp of when the document was created.", "format": "Document Id", "required": "yes", - "validation": "The document ID validation is performed based on timestamp thresholds:\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." + "validation": "The document ID validation is performed based on timestamp thresholds:\n\n* If `future_threshold` is configured, the document `id` cannot be too far in the future from the\ncurrent time.\n* If `past_threshold` is configured, the document `id` cannot be too far in the past from the\ncurrent time." }, "parameters": { "description": "A reference to the Parameters Document this document lies under.", From 0b5fd61bf3b6cc7148e64f0198c09364cbe635aa Mon Sep 17 00:00:00 2001 From: nathanbogale Date: Mon, 17 Nov 2025 18:52:59 +0300 Subject: [PATCH 9/9] fix(docs): correct formatting in metadata template validation description --- specs/definitions/signed_docs/metadata_template.cue | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specs/definitions/signed_docs/metadata_template.cue b/specs/definitions/signed_docs/metadata_template.cue index b872cf5d8b1..37f273de0e0 100644 --- a/specs/definitions/signed_docs/metadata_template.cue +++ b/specs/definitions/signed_docs/metadata_template.cue @@ -11,7 +11,7 @@ _template_description: """ Reference to the template used to create and/or validate this document. """ _template_validation: """ - In addition to the validation performed for `Document Reference` type fields, + In addition to the validation performed for `Document Reference` type fields, The document payload is not valid if it does not validate completely against the referenced template. """