udpate specs

Mr-Leshiy · Mr-Leshiy · commit 6fdae93f1d43 · 2025-10-22T22:08:24.000+07:00
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
@@ -186,10 +186,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version.
 
 ## Copyright
 
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
@@ -123,9 +123,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -215,10 +215,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -215,10 +215,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following User roles may sign documents of this type:
 
 * Registered
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -242,9 +242,7 @@ The following User roles may sign documents of this type:
 
 * Registered
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -217,10 +217,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version.
 
 ## Copyright
 
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
@@ -153,9 +153,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -247,9 +247,7 @@ The following Admin roles may sign documents of this type:
 * Brand Admin
 * Campaign Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
diff --git a/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md b/docs/src/architecture/08_concepts/signed_doc/docs/proposal.md
@@ -229,10 +229,7 @@ The following User roles may sign documents of this type:
 
 * Proposer
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version.
 
 ## Copyright
 
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
@@ -266,9 +266,7 @@ The following User roles may sign documents of this type:
 
 * Registered
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -153,9 +153,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -153,9 +153,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following User roles may sign documents of this type:
 
 * Registered
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -130,7 +130,6 @@ The document version must always be >= the document ID.
 | --- | --- |
 | Required | yes |
 | Format | [Document Reference](../metadata.md#document-reference) |
-| Multiple References | True |
 | Valid References | [Proposal](proposal.md) |
 <!-- markdownlint-enable MD033 -->
 Reference to a Linked Document or Documents.
@@ -319,10 +318,7 @@ The following User roles may sign documents of this type:
 
 * Proposer
 
-New versions of this document may be published by:
-
-* author
-* collaborators
+Updates are allowed by the original author and from the 'collaborators' metadata field of the referenced document specified by the 'ref' metadata field.
 
 ## Copyright
 
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
@@ -272,9 +272,7 @@ The following User roles may sign documents of this type:
 
 * Representative
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -187,9 +187,7 @@ The following User roles may sign documents of this type:
 
 * Representative
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
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
@@ -151,9 +151,7 @@ The following Admin roles may sign documents of this type:
 
 * Brand Admin
 
-New versions of this document may be published by:
-
-* author
+Only the original author can update and sign a new version of documents.
 
 ## Copyright
 
diff --git a/specs/definitions/signed_docs/docs/generic_parameters.cue b/specs/definitions/signed_docs/docs/generic_parameters.cue
@@ -60,7 +60,7 @@ _parameters_payload_description: """
 				"Brand Admin",
 			]
 		}
-		update: collaborators: "collaborators"
+		update: type: "collaborators"
 	}
 
 	authors: {
diff --git a/specs/definitions/signed_docs/docs/proposal.cue b/specs/definitions/signed_docs/docs/proposal.cue
@@ -91,7 +91,7 @@ docs: #DocumentDefinitions & {
 				"Proposer",
 			]
 
-			update: collaborators: "collaborators"
+			update: type: "collaborators"
 		}
 
 		authors: "Steven Johnson": "steven.johnson@iohk.io"
diff --git a/specs/definitions/signed_docs/docs/proposal_submission_action.cue b/specs/definitions/signed_docs/docs/proposal_submission_action.cue
@@ -134,7 +134,7 @@ docs: #DocumentDefinitions & {
 				]
 			}
 
-			update: collaborators: "ref"
+			update: type: "ref"
 		}
 
 		versions: [
diff --git a/specs/definitions/signed_docs/signers.cue b/specs/definitions/signed_docs/signers.cue
@@ -48,14 +48,23 @@ _allAdminRoles: or(_allAdminRolesList)
 	admin?: #allowedAdminRoles
 }
 
-// Listed collaborators can post updated versions based on the metadata field as a source of collaborators information
-#collaboratorsDef: "collaborators" | "ref" | *"excluded"
+#allowedUpdaterType: "collaborators" | "ref" | *"author"
+
+#updaterDescriptions: {
+	collaborators: "Updates are allowed by the original author and from the 'collaborators' metadata field of the previous submitted document's version."
+	ref: "Updates are allowed by the original author and from the 'collaborators' metadata field of the referenced document specified by the 'ref' metadata field."
+	author: "Only the original author can update and sign a new version of documents."
+}
 
 #allowedUpdaters: {
-	collaborators:  #collaboratorsDef
-	author:         bool | *true  // The original author can post updated versions
+	// The type defaults to "author" from #allowedUpdaterType
+	type: #allowedUpdaterType
+
+	// The description is looked up from the map using the value of 'type'
+	description: #updaterDescriptions[type]
 }
 
+
 #allowedSigners: {
 	// Who is allowed to sign a new document
 	// TODO: Import roles from a role definition configuration.
@@ -71,5 +80,4 @@ _allowedSigners: #allowedSigners & {
 			_allUserRolesList[0],
 		]
 	}
-	update: #allowedUpdaters
 }
diff --git a/specs/generators/packages/spec/src/spec/signers.py b/specs/generators/packages/spec/src/spec/signers.py
@@ -1,14 +1,15 @@
 """Signers Specification."""
 
-from pydantic import BaseModel, ConfigDict, Field, Enum
+from pydantic import BaseModel, ConfigDict, Field
+from enum import Enum
 
 
-class Collaborators(str, Enum):
+class CollaboratorsType(str, Enum):
     """Signders Collaborators Specification."""
 
-    collaborators_field_based = "collaborators"
+    collaborators = "collaborators"
     ref_field_based = "ref"
-    excluded = "excluded"
+    author = "author"
 
 
 class AllowedRoles(BaseModel):
@@ -23,8 +24,8 @@ class AllowedRoles(BaseModel):
 class AllowedUpdaters(BaseModel):
     """Allowed Updaters Specification."""
 
-    collaborators: Collaborators
-    author: bool = Field(default=True)
+    type: CollaboratorsType
+    description: str
 
     model_config = ConfigDict(extra="forbid")
 
@@ -33,7 +34,6 @@ class Signers(BaseModel):
     """Signers Specification."""
 
     roles: AllowedRoles
-    referenced: bool = Field(default=False)
-    update: dict[str, bool]
+    update: AllowedUpdaters
 
     model_config = ConfigDict(extra="forbid")
diff --git a/specs/generators/src/docs/docs_page_md.py b/specs/generators/src/docs/docs_page_md.py
@@ -123,10 +123,7 @@ def add_role_group(name: str, roles: list[str]) -> None:
 
         signers_doc = signers_doc.strip()
 
-        signers_doc += "\n\nNew versions of this document may be published by:\n\n"
-        for updater in signers.update:
-            if signers.update[updater]:
-                signers_doc += f"* {updater}\n"
+        signers_doc += f"\n\n{signers.update.description}\n\n"
 
         return signers_doc.strip()
 
diff --git a/specs/signed_doc.json b/specs/signed_doc.json
