app.tempomusic.richtext.facet

lexicons.tempomusic.fan

Documentation

Annotation of a sub-string within text. Features describe the meaning of the annotated range: mention, link, tag, or inline music reference.

main object

Annotation of a sub-string within text. Features describe the meaning of the annotated range: mention, link, tag, or inline music reference.

Properties

index ref #byteSlice Required

No description available.

View raw schema
{
  "type": "object",
  "required": [
    "index",
    "features"
  ],
  "properties": {
    "index": {
      "ref": "#byteSlice",
      "type": "ref"
    },
    "features": {
      "type": "array",
      "items": {
        "refs": [
          "#mention",
          "#link",
          "#tag",
          "#music"
        ],
        "type": "union"
      }
    }
  },
  "description": "Annotation of a sub-string within text. Features describe the meaning of the annotated range: mention, link, tag, or inline music reference."
}
byteSlice object

Specifies the sub-string range a facet annotates. Indices are zero-indexed byte offsets, inclusive of byteStart and exclusive of byteEnd, against the UTF-8 encoding of the text field.

Properties

byteEnd integer Required

No description available.

minimum: 0
byteStart integer Required

No description available.

minimum: 0
View raw schema
{
  "type": "object",
  "required": [
    "byteStart",
    "byteEnd"
  ],
  "properties": {
    "byteEnd": {
      "type": "integer",
      "minimum": 0
    },
    "byteStart": {
      "type": "integer",
      "minimum": 0
    }
  },
  "description": "Specifies the sub-string range a facet annotates. Indices are zero-indexed byte offsets, inclusive of byteStart and exclusive of byteEnd, against the UTF-8 encoding of the text field."
}
link object

Facet feature for an external URL embedded inline in text.

Properties

uri string uri Required

A valid URI.

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri"
    }
  },
  "description": "Facet feature for an external URL embedded inline in text."
}
mention object

Facet feature for a mention of another Tempo account by DID.

Properties

did string did Required

A decentralized identifier (DID).

View raw schema
{
  "type": "object",
  "required": [
    "did"
  ],
  "properties": {
    "did": {
      "type": "string",
      "format": "did"
    }
  },
  "description": "Facet feature for a mention of another Tempo account by DID."
}
music object

Facet feature for an inline reference to a musical entity (song, album, or artist). Allows linking music inside the text body of a post, distinct from the post's primary subject.

Properties

View raw schema
{
  "type": "object",
  "required": [
    "subject"
  ],
  "properties": {
    "subject": {
      "refs": [
        "app.tempomusic.feed.defs#songRef",
        "app.tempomusic.feed.defs#albumRef",
        "app.tempomusic.feed.defs#artistRef"
      ],
      "type": "union"
    }
  },
  "description": "Facet feature for an inline reference to a musical entity (song, album, or artist). Allows linking music inside the text body of a post, distinct from the post's primary subject."
}
tag object

Facet feature for a topical hashtag. The tag string omits any leading '#' character.

Properties

tag string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
View raw schema
{
  "type": "object",
  "required": [
    "tag"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  },
  "description": "Facet feature for a topical hashtag. The tag string omits any leading '#' character."
}

Lexicon Garden

@