# link.latr.bookmarks.defs

> Published by [samclemente.me](https://lexicon.garden/identity/did:plc:qy5pluw2bsuq2x6albsgkvx3)

✓ This is the authoritative definition for this NSID.

## Links

- [View on Lexicon Garden](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.bookmarks.defs)
- [Documentation](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.bookmarks.defs/docs)
- [Examples](https://lexicon.garden/lexicon/did:plc:qy5pluw2bsuq2x6albsgkvx3/link.latr.bookmarks.defs/examples)

## Definitions

### `link.latr.bookmarks.defs#preview`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `image` | `string` (uri) | No |  |
| `title` | `string` | No |  |
| `author` | `string` | No |  |
| `siteName` | `string` | No |  |
| `description` | `string` | No |  |

### `link.latr.bookmarks.defs#simpleOk`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ok` | `boolean` | Yes |  |

### `link.latr.bookmarks.defs#tagCount`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tag` | `string` | Yes |  |
| `count` | `integer` | Yes |  |

### `link.latr.bookmarks.defs#bookmarkView`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `ref` → `community.lexicon.bookmarks.bookmark` | Yes |  |
| `preview` | `ref` → `#preview` | No |  |
| `metadataRecord` | `ref` → `#metadataRecord` | No |  |

### `link.latr.bookmarks.defs#bookmarkRecord`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `ref` → `community.lexicon.bookmarks.bookmark` | Yes |  |

### `link.latr.bookmarks.defs#metadataRecord`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `cid` | `string` (cid) | Yes |  |
| `uri` | `string` (at-uri) | Yes |  |
| `value` | `ref` → `link.latr.bookmarks.metadata` | Yes |  |

### `link.latr.bookmarks.defs#migrationResult`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ok` | `boolean` | Yes |  |
| `cached` | `integer` | Yes |  |
| `cursor` | `string` | No |  |
| `reused` | `integer` | Yes |  |
| `created` | `integer` | Yes |  |
| `retired` | `integer` | Yes |  |
| `scanned` | `integer` | Yes |  |
| `duplicates` | `integer` | Yes |  |
| `skippedConflict` | `integer` | Yes |  |

### `link.latr.bookmarks.defs#tagMutationResult`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ok` | `boolean` | Yes |  |
| `cursor` | `string` | No |  |
| `matched` | `integer` | Yes |  |
| `scanned` | `integer` | Yes |  |
| `updated` | `integer` | Yes |  |

### `link.latr.bookmarks.defs#metadataSyncResult`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `ok` | `boolean` | Yes |  |
| `cursor` | `string` | No |  |
| `reused` | `integer` | Yes |  |
| `created` | `integer` | Yes |  |
| `scanned` | `integer` | Yes |  |
| `skippedConflict` | `integer` | Yes |  |

### `link.latr.bookmarks.defs#communityBookmarkRecord`

**Type**: `object`

| Property | Type | Required | Description |
|----------|------|----------|-------------|
| `tags` | `array` | No |  |
| `subject` | `string` (uri) | Yes |  |
| `createdAt` | `string` (datetime) | Yes |  |

## Raw Schema

```json
{
  "id": "link.latr.bookmarks.defs",
  "defs": {
    "preview": {
      "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": {
      "type": "object",
      "required": [
        "ok"
      ],
      "properties": {
        "ok": {
          "type": "boolean"
        }
      }
    },
    "tagCount": {
      "type": "object",
      "required": [
        "tag",
        "count"
      ],
      "properties": {
        "tag": {
          "type": "string",
          "maxLength": 640,
          "maxGraphemes": 64
        },
        "count": {
          "type": "integer",
          "minimum": 1
        }
      }
    },
    "bookmarkView": {
      "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"
        }
      }
    },
    "bookmarkRecord": {
      "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"
        }
      }
    },
    "metadataRecord": {
      "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"
        }
      }
    },
    "migrationResult": {
      "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
        }
      }
    },
    "tagMutationResult": {
      "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
        }
      }
    },
    "metadataSyncResult": {
      "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
        }
      }
    },
    "communityBookmarkRecord": {
      "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"
        }
      }
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}
```