A single paragraph of rich text with optional facet annotations.
Used for descriptions and other short formatted text.
Properties
Annotations of text (mentions, URLs, hashtags, formatting, etc).
The plain text content (no markdown symbols).
maxLength: 500000 bytesmaxGraphemes: 50000 graphemes
View raw schema
{
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 500000,
"description": "The plain text content (no markdown symbols).",
"maxGraphemes": 50000
},
"facets": {
"type": "array",
"items": {
"ref": "com.deckbelcher.richtext.facet",
"type": "ref"
},
"description": "Annotations of text (mentions, URLs, hashtags, formatting, etc)."
}
},
"description": "A single paragraph of rich text with optional facet annotations.\nUsed for descriptions and other short formatted text."
}
An unordered (bullet) list.
View raw schema
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"ref": "#listItem",
"type": "ref"
},
"description": "The list items."
}
},
"description": "An unordered (bullet) list."
}
A code block with optional language hint.
Properties
Optional language identifier for syntax highlighting.
maxLength: 50 bytes
The code content (plain text, no facets).
maxLength: 100000 bytes
View raw schema
{
"type": "object",
"required": [
"text"
],
"properties": {
"text": {
"type": "string",
"maxLength": 100000,
"description": "The code content (plain text, no facets)."
},
"language": {
"type": "string",
"maxLength": 50,
"description": "Optional language identifier for syntax highlighting."
}
},
"description": "A code block with optional language hint."
}
A multi-block rich text document.
Used for primers and other long-form content.
Properties
Array of blocks (paragraphs, headings, etc).
View raw schema
{
"type": "object",
"required": [
"content"
],
"properties": {
"content": {
"type": "array",
"items": {
"refs": [
"#paragraphBlock",
"#headingBlock",
"#codeBlock",
"#bulletListBlock",
"#orderedListBlock",
"#horizontalRuleBlock"
],
"type": "union"
},
"description": "Array of blocks (paragraphs, headings, etc)."
}
},
"description": "A multi-block rich text document.\nUsed for primers and other long-form content."
}
A heading block with level, text, and optional facets.
Properties
Annotations of text (formatting, mentions, links, etc).
Heading level (1-6).
minimum: 1maximum: 6
The plain text content (no markdown symbols).
maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
View raw schema
{
"type": "object",
"required": [
"level"
],
"properties": {
"text": {
"type": "string",
"maxLength": 10000,
"description": "The plain text content (no markdown symbols).",
"maxGraphemes": 1000
},
"level": {
"type": "integer",
"maximum": 6,
"minimum": 1,
"description": "Heading level (1-6)."
},
"facets": {
"type": "array",
"items": {
"ref": "com.deckbelcher.richtext.facet",
"type": "ref"
},
"description": "Annotations of text (formatting, mentions, links, etc)."
}
},
"description": "A heading block with level, text, and optional facets."
}
A horizontal rule (thematic break).
This object has no properties defined.
View raw schema
{
"type": "object",
"properties": {},
"description": "A horizontal rule (thematic break)."
}
A single list item with text, optional facets, and optional sublist.
Properties
Annotations of text (formatting, mentions, links, etc).
Optional nested sublist (bullet or ordered).
The plain text content (no markdown symbols).
maxLength: 100000 bytesmaxGraphemes: 10000 graphemes
View raw schema
{
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 100000,
"description": "The plain text content (no markdown symbols).",
"maxGraphemes": 10000
},
"facets": {
"type": "array",
"items": {
"ref": "com.deckbelcher.richtext.facet",
"type": "ref"
},
"description": "Annotations of text (formatting, mentions, links, etc)."
},
"sublist": {
"refs": [
"#bulletListBlock",
"#orderedListBlock"
],
"type": "union",
"description": "Optional nested sublist (bullet or ordered)."
}
},
"description": "A single list item with text, optional facets, and optional sublist."
}
An ordered (numbered) list.
Properties
Starting number (default 1).
View raw schema
{
"type": "object",
"required": [
"items"
],
"properties": {
"items": {
"type": "array",
"items": {
"ref": "#listItem",
"type": "ref"
},
"description": "The list items."
},
"start": {
"type": "integer",
"description": "Starting number (default 1)."
}
},
"description": "An ordered (numbered) list."
}
A paragraph block with text and optional facets.
Properties
Annotations of text (formatting, mentions, links, etc).
The plain text content (no markdown symbols).
maxLength: 500000 bytesmaxGraphemes: 50000 graphemes
View raw schema
{
"type": "object",
"properties": {
"text": {
"type": "string",
"maxLength": 500000,
"description": "The plain text content (no markdown symbols).",
"maxGraphemes": 50000
},
"facets": {
"type": "array",
"items": {
"ref": "com.deckbelcher.richtext.facet",
"type": "ref"
},
"description": "Annotations of text (formatting, mentions, links, etc)."
}
},
"description": "A paragraph block with text and optional facets."
}