Comment Moderation Action¶
Description¶
A Moderation Action performed on any Comment.
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/json
- content-encoding =
[br]
Metadata¶
type
¶
Parameter | Value |
---|---|
Required | yes |
Format | Document Type |
Type | 5e60e623-ad02-4a1b-a1ac-406db978ee48 ,b679ded3-0e7c-41ba-89f8-da62a17898ea ,a5d232b8-5e03-4117-9afd-be32b878fcdd |
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.
ref
¶
Parameter | Value |
---|---|
Required | yes |
Format | Document Reference |
Valid References | Proposal Comment |
Reference to a Linked Document or Documents. This is the primary hierarchical reference to a related document.
This is an Array of the format:
If a reference is defined as required, there must be at least 1 reference specified. Some documents allow multiple references, and they are documented as required.
document_id
is the UUIDv7 ID of the Document being referenced.document_ver
is the UUIDv7 Version of the Document being referenced.-
document_locator
is a content unique locator for the document. This serves two purposes. -
It ensures that the document referenced by an ID/Version is not substituted. In other words, that the document intended to be referenced, is actually referenced.
- Allow the document to be unambiguously located in decentralized storage systems.
There can be any number of Document Locations in any reference. The currently defined locations are:
cid
: A CBOR Encoded IPLD Content Identifier ( AKA an IPFS CID ).- Others may be added when further storage mechanisms are defined.
The value set here does not guarantee that the document is actually stored. It only defines that if it were stored, this is the identifier that that is required to retrieve it.
Validation¶
The following must be true for a valid reference:
- The Referenced Document MUST Exist
- Every value in the
document_locator
must consistently reference the exact same document. - The
document_id
anddocument_ver
MUST match the values in the referenced document.
Payload¶
TODO
Signers¶
The following user roles may sign documents of this type:
- Registered
New versions of this document may be published by:
- author
Copyright¶
Copyright | |
---|---|
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