Comments data
Fields:
| Field Name | Type | Required | Description |
|---|---|---|---|
| id | string, number | Yes | Unique identifier of comment. |
| card_id | string, number | Yes | Unique identifier of card under which the comment is written. |
| text | string | Yes | The main content of the comment, supporting both Markdown and HTML formats. |
| author_id | string, number, null | No | Unique identifier of comment author. |
| author_name | string, null | No | Full name of comment author. |
| created | string | null | No | Date of creation of comment. |
| parent_id | string, number, null | No | ID of parent comment. |
| type | string | null | No | Specifies the format of the comment content. Accepted values are 'html' and 'markdown'. |
Description of fields:
id:
A unique identifier of comment, which is used to map and track the comment within our system.
card_id:
A unique identifier of card, under which the comment is written, which is used to map and track the comment within our system.
text:
Represents the body of the comment. This field supports both Markdown and HTML formatting. It's possible to create cross-links to documents and cards: for Markdown links have to be like /[.*?](((?:card|document)/[a-zA-Z0-9-]+))/, for HTML – /href="((?:card|document)/[a-zA-Z0-9-]+)"/, where [a-zA-Z0-9-]+ is document or card ID. Examples: [cardTitle](card/ca3d1d44-1b1b-4b1b-8b1b-ca3d1dca3d1dca), href="document/D0C1D222-1B1B-4B1B-8B1B-D0C1DD0C1DD0".
author_id:
A unique identifier of author for comment, used to map and track the comment, make relation to author, and display
author_name:
Name of the author who wrote the comment, used for display purposes
created:
Date of comment creation. If empty, the current date will be used by default.
parent_id:
A unique identifier of parent comment in a thread
type:
Defines the format in which the comment's content is structured. The accepted formats are 'html' for HTML-formatted content and 'markdown' for content using Markdown syntax. If not explicitly provided, the system defaults to using the 'markdown' format. This field ensures consistency in how the comment content is rendered and interpreted within the system.
JSON schema:
