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

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