net.hrkn.personas.bookmark Documentation (EN)

main record

A bookmark record for saving and organizing references to posts, profiles, or external content

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When the bookmark was created

subject union Required

The target being bookmarked

Known types:

#strongRef
#externalRef

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "subject",
      "createdAt"
    ],
    "properties": {
      "subject": {
        "refs": [
          "#strongRef",
          "#externalRef"
        ],
        "type": "union",
        "description": "The target being bookmarked"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "When the bookmark was created"
      }
    }
  },
  "description": "A bookmark record for saving and organizing references to posts, profiles, or external content"
}

externalRef object

Reference to external content outside AT Protocol

Properties

description string Optional

Description of the external content

maxLength: 1000 bytes

title string Optional

Title of the external content

maxLength: 500 bytes

uri string uri Required

URI of the external content

View raw schema

{
  "type": "object",
  "required": [
    "uri"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "URI of the external content"
    },
    "title": {
      "type": "string",
      "maxLength": 500,
      "description": "Title of the external content"
    },
    "description": {
      "type": "string",
      "maxLength": 1000,
      "description": "Description of the external content"
    }
  },
  "description": "Reference to external content outside AT Protocol"
}

strongRef object

No description available.

Properties

cid string Required

No description available.

uri string uri Required

A valid URI.

View raw schema

{
  "type": "object",
  "required": [
    "uri",
    "cid"
  ],
  "properties": {
    "cid": {
      "type": "string"
    },
    "uri": {
      "type": "string",
      "format": "uri"
    }
  }
}