A facet
Properties
The features applied to the facet
The atom range this facet covers
View raw schema
{
"type": "object",
"required": [
"index"
],
"properties": {
"index": {
"ref": "#index",
"type": "ref",
"description": "The atom range this facet covers"
},
"features": {
"type": "array",
"items": {
"refs": [
"#bold",
"#italic",
"#underline",
"#strikethrough",
"#link",
"#highlight"
],
"type": "union",
"closed": false
},
"description": "The features applied to the facet"
}
},
"description": "A facet"
}
A bold facet
This object has no properties defined.
View raw schema
{
"type": "object",
"properties": {},
"description": "A bold facet"
}
A date/time facet
Properties
True if the time component should be ignored - defaults to false
View raw schema
{
"type": "object",
"properties": {
"value": {
"type": "string",
"format": "datetime",
"description": "The date/time value"
},
"dateOnly": {
"type": "boolean",
"default": false,
"description": "True if the time component should be ignored - defaults to false"
}
},
"description": "A date/time facet"
}
A highlight facet
Properties
The color of the highlight
View raw schema
{
"type": "object",
"properties": {
"color": {
"type": "string",
"description": "The color of the highlight"
}
},
"description": "A highlight facet"
}
An atom range of a facet
Properties
The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`
The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`
View raw schema
{
"type": "object",
"required": [
"atomStart",
"atomEnd"
],
"properties": {
"atomEnd": {
"type": "string",
"description": "The end atom id of the facet (inclusive) - formatted as `operationId.atomIdx`"
},
"atomStart": {
"type": "string",
"description": "The start atom id of the facet (inclusive) - formatted as `operationId.atomIdx`"
}
},
"description": "An atom range of a facet"
}
An italic facet
This object has no properties defined.
View raw schema
{
"type": "object",
"properties": {},
"description": "An italic facet"
}
A link facet
Properties
The URL of the linked resource
View raw schema
{
"type": "object",
"properties": {
"url": {
"type": "string",
"format": "uri",
"description": "The URL of the linked resource"
}
},
"description": "A link facet"
}
A mention facet
Properties
The did of the mentioned user
View raw schema
{
"type": "object",
"properties": {
"did": {
"type": "string",
"format": "did",
"description": "The did of the mentioned user"
}
},
"description": "A mention facet"
}
A strikethrough facet
This object has no properties defined.
View raw schema
{
"type": "object",
"properties": {},
"description": "A strikethrough facet"
}
An underline facet
This object has no properties defined.
View raw schema
{
"type": "object",
"properties": {},
"description": "An underline facet"
}