Proposal Comment Template¶

Description¶

Proposal Comment Template Document¶

A Proposal Comment Template defines the allowed payload contents of a linked proposal comment.

Proposal comments themselves are intentionally general, however they may be linked to a brand/campaign or category via the template used by the proposal.

The payload of a proposal comment is controlled by its 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`, `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.

`template`¶

Parameter	Value
Required	optional
Format	Document Reference
Valid References	Proposal Comment Meta Template

Reference to the template used to create and/or validate this document.

Validation¶

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.

`brand_id`¶

Parameter	Value
Required	optional
Format	Document Reference
Valid References	Brand Parameters
Exclusive	`campaign_id`
	`category_id`

A reference to the Brand 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 brand_id must match the brand_id of the referencing document.
MUST NOT be present in any document that contains campaign_id and category_id metadata.

`campaign_id`¶

Parameter	Value
Required	optional
Format	Document Reference
Valid References	Campaign Parameters
Exclusive	`brand_id`
	`category_id`

A reference to the Campaign 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 campaign_id must match the campaign_id of the referencing document.
MUST NOT be present in any document that contains brand_id and category_id metadata.

`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_id must match the category_id of the referencing document.
MUST NOT be present in any document that contains brand_id and campaign_id metadata.

Payload¶

JSON Schema document which defines the content of the Proposal Comments.

Signers¶

The following admin roles may sign documents of this type:

Brand Admin
Campaign 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