link.latr.bookmarks.defs

samclemente.me

Documentation

bookmarkRecord object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

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",
    "cid",
    "value"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "value": {
      "ref": "community.lexicon.bookmarks.bookmark",
      "type": "ref"
    }
  }
}
bookmarkView object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

preview ref #preview Optional

No description available.

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",
    "cid",
    "value"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "value": {
      "ref": "community.lexicon.bookmarks.bookmark",
      "type": "ref"
    },
    "preview": {
      "ref": "#preview",
      "type": "ref"
    },
    "metadataRecord": {
      "ref": "#metadataRecord",
      "type": "ref"
    }
  }
}
communityBookmarkRecord object

No description available.

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

subject string uri Required

A valid URI.

maxLength: 8192 bytesmaxGraphemes: 2048 graphemes
tags array of string Optional

No description available.

maxLength: 100 items
View raw schema 
{
  "type": "object",
  "required": [
    "subject",
    "createdAt"
  ],
  "properties": {
    "tags": {
      "type": "array",
      "items": {
        "type": "string",
        "maxLength": 640,
        "maxGraphemes": 64
      },
      "maxLength": 100
    },
    "subject": {
      "type": "string",
      "format": "uri",
      "maxLength": 8192,
      "maxGraphemes": 2048
    },
    "createdAt": {
      "type": "string",
      "format": "datetime"
    }
  }
}
metadataRecord object

No description available.

Properties

cid string cid Required

A content identifier (CID) referencing immutable data.

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",
    "cid",
    "value"
  ],
  "properties": {
    "cid": {
      "type": "string",
      "format": "cid"
    },
    "uri": {
      "type": "string",
      "format": "at-uri"
    },
    "value": {
      "ref": "link.latr.bookmarks.metadata",
      "type": "ref"
    }
  }
}
metadataSyncResult object

No description available.

Properties

created integer Required

No description available.

minimum: 0
cursor string Optional

No description available.

maxLength: 2048 bytesmaxGraphemes: 512 graphemes
ok boolean Required

No description available.

reused integer Required

No description available.

minimum: 0
scanned integer Required

No description available.

minimum: 0
skippedConflict integer Required

No description available.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "ok",
    "scanned",
    "created",
    "reused",
    "skippedConflict"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "maxGraphemes": 512
    },
    "reused": {
      "type": "integer",
      "minimum": 0
    },
    "created": {
      "type": "integer",
      "minimum": 0
    },
    "scanned": {
      "type": "integer",
      "minimum": 0
    },
    "skippedConflict": {
      "type": "integer",
      "minimum": 0
    }
  }
}
migrationResult object

No description available.

Properties

cached integer Required

No description available.

minimum: 0
created integer Required

No description available.

minimum: 0
cursor string Optional

No description available.

maxLength: 2048 bytesmaxGraphemes: 512 graphemes
duplicates integer Required

No description available.

minimum: 0
ok boolean Required

No description available.

retired integer Required

No description available.

minimum: 0
reused integer Required

No description available.

minimum: 0
scanned integer Required

No description available.

minimum: 0
skippedConflict integer Required

No description available.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "ok",
    "scanned",
    "created",
    "reused",
    "duplicates",
    "skippedConflict",
    "cached",
    "retired"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "cached": {
      "type": "integer",
      "minimum": 0
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "maxGraphemes": 512
    },
    "reused": {
      "type": "integer",
      "minimum": 0
    },
    "created": {
      "type": "integer",
      "minimum": 0
    },
    "retired": {
      "type": "integer",
      "minimum": 0
    },
    "scanned": {
      "type": "integer",
      "minimum": 0
    },
    "duplicates": {
      "type": "integer",
      "minimum": 0
    },
    "skippedConflict": {
      "type": "integer",
      "minimum": 0
    }
  }
}
preview object

No description available.

Properties

author string Optional

No description available.

maxLength: 512 bytesmaxGraphemes: 128 graphemes
description string Optional

No description available.

maxLength: 8192 bytesmaxGraphemes: 2048 graphemes
image string uri Optional

A valid URI.

maxLength: 8192 bytesmaxGraphemes: 2048 graphemes
siteName string Optional

No description available.

maxLength: 512 bytesmaxGraphemes: 128 graphemes
title string Optional

No description available.

maxLength: 2048 bytesmaxGraphemes: 512 graphemes
View raw schema 
{
  "type": "object",
  "required": [],
  "properties": {
    "image": {
      "type": "string",
      "format": "uri",
      "maxLength": 8192,
      "maxGraphemes": 2048
    },
    "title": {
      "type": "string",
      "maxLength": 2048,
      "maxGraphemes": 512
    },
    "author": {
      "type": "string",
      "maxLength": 512,
      "maxGraphemes": 128
    },
    "siteName": {
      "type": "string",
      "maxLength": 512,
      "maxGraphemes": 128
    },
    "description": {
      "type": "string",
      "maxLength": 8192,
      "maxGraphemes": 2048
    }
  }
}
simpleOk object

No description available.

Properties

ok boolean Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "ok"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    }
  }
}
tagCount object

No description available.

Properties

count integer Required

No description available.

minimum: 1
tag string Required

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
View raw schema 
{
  "type": "object",
  "required": [
    "tag",
    "count"
  ],
  "properties": {
    "tag": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "count": {
      "type": "integer",
      "minimum": 1
    }
  }
}
tagMutationResult object

No description available.

Properties

cursor string Optional

No description available.

maxLength: 2048 bytesmaxGraphemes: 512 graphemes
matched integer Required

No description available.

minimum: 0
ok boolean Required

No description available.

scanned integer Required

No description available.

minimum: 0
updated integer Required

No description available.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "ok",
    "scanned",
    "matched",
    "updated"
  ],
  "properties": {
    "ok": {
      "type": "boolean"
    },
    "cursor": {
      "type": "string",
      "maxLength": 2048,
      "maxGraphemes": 512
    },
    "matched": {
      "type": "integer",
      "minimum": 0
    },
    "scanned": {
      "type": "integer",
      "minimum": 0
    },
    "updated": {
      "type": "integer",
      "minimum": 0
    }
  }
}

Lexicon Garden

@