com.kipclip.annotation Documentation (EN)

main record

Enrichment data and optional user note for a bookmark

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 10000 bytes

favicon string uri Optional

A valid URI.

image string uri Optional

A valid URI.

note string Optional

User note for this bookmark

maxLength: 10000 bytes

subject string at-uri Required

AT URI of the bookmark this annotates

title string Optional

No description available.

maxLength: 1000 bytes

View raw schema

{
  "description": "Enrichment data and optional user note for a bookmark",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxLength": 10000,
        "type": "string"
      },
      "favicon": {
        "format": "uri",
        "type": "string"
      },
      "image": {
        "format": "uri",
        "type": "string"
      },
      "note": {
        "description": "User note for this bookmark",
        "maxLength": 10000,
        "type": "string"
      },
      "subject": {
        "description": "AT URI of the bookmark this annotates",
        "format": "at-uri",
        "type": "string"
      },
      "title": {
        "maxLength": 1000,
        "type": "string"
      }
    },
    "required": [
      "subject",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}