f3-schemas/comment.json
Earl Warren df9b10ec3a
comment: attachments are not embedded in the comment
* they are objects, children of the comment
* embeding objects which are references to a blob within a comment
  is impractical because it is JSON
2023-12-09 11:22:53 +01:00

57 lines
1.2 KiB
JSON

{
"title": "Comment",
"description": "Comment associated to a commentable object (i.e. issue, review, etc.). Forge users add a comment to an object to create a non-threaded conversation.",
"type": "object",
"additionalProperties": false,
"properties": {
"index": {
"description": "Unique identifier of the comment.",
"type": "string"
},
"poster_id": {
"description": "Unique identifier of the comment author.",
"type": "string"
},
"created": {
"description": "Creation time.",
"type": "string",
"format": "date-time"
},
"updated": {
"description": "Last update time.",
"type": "string",
"format": "date-time"
},
"content": {
"description": "Markdown content of the comment.",
"type": "string"
},
"reactions": {
"description": "List of reactions.",
"anyOf": [
{
"type": "array",
"items": {
"$ref": "reaction.json"
}
},
{
"type": "null"
}
]
}
},
"required": [
"index",
"poster_id",
"created",
"updated",
"content"
],
"$schema": "http://json-schema.org/draft-04/schema#",
"$id": "https://lab.forgefriends.org/friendlyforgeformat/f3-schemas/-/blob/v1.0/comment.json",
"$$target": "comment.json"
}