com.lognship.richtext.facet

lognship.com

Documentation

Annotation of a sub-string within a host record's text. Holds a byte range and one or more semantic features describing what the range means.

main object

Annotation of a sub-string within a host record's text. Holds a byte range and one or more semantic features describing what the range means.

Properties

features array of union Required

No description available.

minLength: 1 items
Known types:
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",
          "#atLink"
        ],
        "type": "union"
      },
      "minLength": 1
    }
  },
  "description": "Annotation of a sub-string within a host record's text. Holds a byte range and one or more semantic features describing what the range means."
}
atLink object

Facet feature for a link to an atproto record (at:// URI). The authority should be normalised to DID form at write time so handle migrations don't break the reference.

Properties

uri string at-uri Required

An AT Protocol URI (e.g., at://did:plc:xyz/app.bsky.feed.post/abc).

View raw schema
{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "at-uri"
    }
  },
  "description": "Facet feature for a link to an atproto record (at:// URI). The authority should be normalised to DID form at write time so handle migrations don't break the reference."
}
byteSlice object

The sub-string range a facet is active for. Indices are UTF-8 byte offsets into the host record's text; byteStart is inclusive, byteEnd is exclusive.

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": "The sub-string range a facet is active for. Indices are UTF-8 byte offsets into the host record's text; byteStart is inclusive, byteEnd is exclusive."
}
link object

Facet feature for any non-AT URI link (https://, mailto:, etc.). For AT URIs, prefer atLink instead so the lexicon validator and the PDS enforce strict at-uri syntax at write time.

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 any non-AT URI link (https://, mailto:, etc.). For AT URIs, prefer atLink instead so the lexicon validator and the PDS enforce strict at-uri syntax at write time."
}
mention object

Facet feature for a mention of an atproto account by DID. The visible handle in the host record's text is informational; the DID is the canonical reference and survives handle migrations.

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 an atproto account by DID. The visible handle in the host record's text is informational; the DID is the canonical reference and survives handle migrations."
}

Lexicon Garden

@