Proposal Comment Meta Template¶
Description¶
Proposal Comment Meta Template Document¶
A Proposal Comment Meta Template is used to enforce functional requirements are met in any Proposal Comment Template.
The payload of a proposal comment template is controlled by its meta template.
Validation¶
This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.
Business Logic¶
Front End¶
This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.
Back End¶
This specification outlines the required definitions for the current features. The document will be incrementally improved in future iterations as more functionality and features are added. This section will be included and updated in future iterations.
COSE Header Parameters¶
- content type =
application/schema+json - content-encoding =
[br]
Metadata¶
type¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Type |
| Type | 0ce8ab38-9258-4fbc-a62e-7faa6e58318f,0ce8ab38-9258-4fbc-a62e-7faa6e58318f,b679ded3-0e7c-41ba-89f8-da62a17898ea,7808d2ba-d511-40af-84e8-c0d1625fdfdc |
The document TYPE.
Validation¶
MUST be a known document type.
id¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | UUIDv7 |
Document ID, created the first time the document is created. This must be a properly created UUIDv7 which contains the timestamp of when the document was created.
Validation¶
IF ver does not == id then a document with
id and ver being equal MUST exist.
ver¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | UUIDv7 |
The unique version of the document.
The first version of the document must set ver == id
Validation¶
The document version must always be >= the document ID.
category_id¶
| Parameter | Value |
|---|---|
| Required | optional |
| Format | Document Reference |
| Valid References | Category Parameters |
| Exclusive | brand_id |
campaign_id |
A reference to the Category Parameters Document this document lies under.
Validation¶
In addition to the validation performed for Document Reference type fields:
- Any linked referenced document that includes a
category_idmust match thecategory_idof the referencing document. - MUST NOT be present in any document that contains
brand_idandcampaign_idmetadata.
Payload¶
JSON Schema document which ensures the minimum required functional requirements of the Proposal Comment Template are met.
This ensures that payloads can be reliably interpreted by business logic processes, while allowing for flexibility to capture extended information.
Must be a valid JSON Schema Draft 7 document.
Signers¶
The following admin roles may sign documents of this type:
- Root Admin
- Brand Admin
New versions of this document may be published by:
- author
Copyright¶
| Copyright |  2024-2025 IOG Singapore, All Rights Reserved |
|---|---|
| License | This document is licensed under CC-BY-4.0 |
| Created | 2024-12-27 |
| Modified | 2025-04-09 |
| Authors | Alex Pozhylenkov alex.pozhylenkov@iohk.io |
| Steven Johnson steven.johnson@iohk.io |
Changelog¶
0.01 (2025-04-04)¶
- First Published Version