Proposal Template¶
Description¶
Proposal Template Document¶
A Proposal Template defines the allowed payload contents of a linked proposal.
Proposals 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 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,7808d2ba-d511-40af-84e8-c0d1625fdfdc |
The document TYPE.
type Validation¶
MUST be a known document type.
id¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Id |
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.
id Validation¶
IF ver does not == id then a document with
id and ver being equal MUST exist.
ver¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Ver |
The unique version of the document.
The first version of the document must set ver == id
ver Validation¶
The document version must always be >= the document ID.
template¶
| Parameter | Value |
|---|---|
| Required | optional |
| Format | Document Reference |
| Valid References | Proposal Meta Template |
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, The document payload is not valid if it does not validate completely against the referenced template.
parameters¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Reference |
| Valid References | Brand Parameters |
| Campaign Parameters | |
| Category Parameters | |
| Linked Reference Metadata | template |
A reference to the Parameters Document this document lies under.
parameters Validation¶
In addition to the validation performed for Document Reference type fields:
- Any linked referenced document that includes a
parametersmetadata must match theparametersof the referencing document. - The Document referenced by
template - MUST contain
parametersmetadata; AND - MUST match the referencing documents
parametersvalue.
Payload¶
JSON Schema document which defines the valid contents of a proposal document.
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-05-05 |
| Authors | Alex Pozhylenkov alex.pozhylenkov@iohk.io |
| Steven Johnson steven.johnson@iohk.io |
Changelog¶
0.01 (2025-04-04)¶
- First Published Version
0.03 (2025-05-05)¶
- Use generalized parameters.