Skip to content

Proposal Comment Form Template

Description

A Proposal Comment Form Template defines both:

  • The data that is entered in the Form.
  • Formatting hints for the collection of the data in a form.

A Proposal Comment Form Template is a JSON Schema Document.

Proposal Comment entry SHOULD use the hints when collecting data defined by the Proposal Comment Form Template to provide a consistent user interface. It CAN also use those hints when re-displaying the full forms data.

Alternatively a Proposal Comment Presentation Template can be used to format the Proposal Comment data for presentation.

The Proposal Comment Document is intentionally general, however it may be linked to a brand/campaign or category via the template used by the Proposal Comment.

The payload of a Proposal Comment is controlled by its template.

Proposal Comment Form TemplateProposal Comment Form Template    Document Relationshipscluster_system_parametersSystem ParametersBrand Parameters                             Brand Parameters                        Campaign Parameters                             Campaign Parameters                        Category Parameters                             Category Parameters                        Proposal Comment Form Template                         Proposal Comment Form Template                    content typeapplication/schema+jsontype0ce8ab38-9258-4fbc-a62e-7faa6e58318fb679ded3-0e7c-41ba-89f8-da62a17898ea7808d2ba-d511-40af-84e8-c0d1625fdfdcidDocument IdverDocument VerparametersBrand ParametersCampaign ParametersCategory ParametersProposal Comment Form Template:e->Brand Parameters1*Proposal Comment                         Proposal Comment                    Proposal Comment:e->Proposal Comment Form Template:w1*

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

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.

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.

parameters

Parameter Value
Required yes
Format Document Reference
Valid References Brand Parameters
Campaign Parameters
Category 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 parameters metadata must match the parameters of the referencing document, or a parent of those parameters.

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

JSON Schema document which defines the valid contents and formatting hints for the collection of data for a Proposal Comment Document.

Signers

The following Admin roles may sign documents of this type:

  • Brand Admin

New versions of this document may be published by:

  • author
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-30
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.

0.04 (2025-05-05)

  • Generalize the Form Template definitions.