Category Parameters¶
Description¶
Category Parameters define the parameter data required for the system at the Category level.
Parameter Data includes things such as:
- Functional parameters
- Timeline data
- Branded Content and Copy
The content of the parameters is defined solely by the Category Parameters Form Template.
This allows parameters to vary based on individual system requirements over time.
Functional Parameters are mapped using the (TBD Functional Parameters Map).
The payload of a Category is controlled by its template.
Validation¶
The Category Parameters Document MUST be linked through parameters to
its Campaign Parameters Document.
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/json - content-encoding =
[br]
Metadata¶
type¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Type |
| Type | 60185874-7e13-407c-a06c-238ffe637ae6,818938c3-3139-4daa-afe6-974c78488e95 |
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 represents new versions of the same document as it changes over time.
ver Validation¶
The document version must always be >= the document ID.
template¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Reference |
| Valid References | Category Parameters Form 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.
collaborators¶
| Parameter | Value |
|---|---|
| Required | optional |
| Format | Collaborators Reference List |
A list of collaborators who may also publish updates to versions of this document. This should include all parties who have not signed this document directly.
Every subsequent version can amend the collaborators list. However, the initial Author can never be removed from being able to publish a new version of the document.
collaborators Validation¶
This list does not imply these collaborators have consented to collaborate, only that the author/s are permitting these potential collaborators to participate in the drafting and submission process. However, any document submission referencing a proposal MUST be signed by all collaborators in addition to the author.
revocations¶
| Parameter | Value |
|---|---|
| Required | optional |
| Format | Version Revocations |
A document may include a list of any prior versions which are considered to be revoked.
Only the revocation list in the latest version of the document applies.
Revoked documents are flagged as no longer valid, and should not be displayed.
As a special case, if the revocations are set to true then all versions of the document
are revoked, including the latest document.
In this case, when the latest document is revoked, the payload may be empty.
Any older document that has revocations set to true is always to be filtered
and its payload is to be assumed to be invalid.
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.
However, any document where revocations was set true can never be reinstated.
revocations Validation¶
If the field is true the payload may be absent or invalid.
Such documents may never be submitted.
parameters¶
| Parameter | Value |
|---|---|
| Required | yes |
| Format | Document Reference |
| Valid References | Campaign Parameters |
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, or a parent of thoseparameters.
For example, a linked reference to Contest Parameters is transitively a reference to
the Parameters document it references, and each parameters document they reference
until the Brand parameters document is reached.
The use case here is for Templates. The profile template, or proposal templates could be defined at any of these levels, and as long as they all refer to the same chain of parameters in the hierarchy they are all valid.
Payload¶
Category Parameters Document controlling the Category within a Campaign.
Must be valid according to the schema contained within the
Document Reference from the template metadata.
Signers¶
The following Admin roles may sign documents of this type:
- Brand Admin
New versions of this document may be published by:
- author
- collaborators
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-06-20 |
| Authors | Alex Pozhylenkov alex.pozhylenkov@iohk.io |
| Nathan Bogale nathan.bogale@iohk.io | |
| Steven Johnson steven.johnson@iohk.io |
Changelog¶
0.01 (2025-04-04)¶
- First Published Version
0.02 (2025-06-20)¶
- Generalized as another kind of form data document