us.off-the-clock.bookmark.preview

off-the-clock.us

Documentation

What a bookmarked page says about itself, kept beside the bookmark by the member's own client: under the record key of its community.lexicon.bookmarks.bookmark, in the same space and repository, so a reader with either record can fetch the other. It is derived from a fetch of the page and rewritten under the same key when refreshed; a page with no usable image gets none.

main record

What a bookmarked page says about itself, kept beside the bookmark by the member's own client: under the record key of its community.lexicon.bookmarks.bookmark, in the same space and repository, so a reader with either record can fetch the other. It is derived from a fetch of the page and rewritten under the same key when refreshed; a page with no usable image gets none.

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

When the page was fetched.

description string Optional

og:description, else the HTML meta description.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
image blob Required

The page's og:image (or oEmbed thumbnail), uploaded as the member's blob.

maxSize: 1.0 MB
imageAlt string Optional

og:image:alt, when the page gives one.

maxLength: 10000 bytesmaxGraphemes: 1000 graphemes
siteName string Optional

og:site_name, else the oEmbed provider name.

maxLength: 2000 bytesmaxGraphemes: 200 graphemes
source string Optional

Where the title and description came from.

maxLength: 64 bytes
Known values: og, oembed, html
title string Optional

og:title, else the oEmbed title, else the HTML title.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes
url string uri Required

The page's final URL, after redirects; the bookmark keeps what was saved.

maxLength: 2048 bytes
View raw schema 
{
  "description": "What a bookmarked page says about itself, kept beside the bookmark by the member's own client: under the record key of its community.lexicon.bookmarks.bookmark, in the same space and repository, so a reader with either record can fetch the other. It is derived from a fetch of the page and rewritten under the same key when refreshed; a page with no usable image gets none.",
  "key": "tid",
  "record": {
    "properties": {
      "createdAt": {
        "description": "When the page was fetched.",
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "description": "og:description, else the HTML meta description.",
        "maxGraphemes": 1000,
        "maxLength": 10000,
        "type": "string"
      },
      "image": {
        "accept": [
          "image/*"
        ],
        "description": "The page's og:image (or oEmbed thumbnail), uploaded as the member's blob.",
        "maxSize": 1000000,
        "type": "blob"
      },
      "imageAlt": {
        "description": "og:image:alt, when the page gives one.",
        "maxGraphemes": 1000,
        "maxLength": 10000,
        "type": "string"
      },
      "siteName": {
        "description": "og:site_name, else the oEmbed provider name.",
        "maxGraphemes": 200,
        "maxLength": 2000,
        "type": "string"
      },
      "source": {
        "description": "Where the title and description came from.",
        "knownValues": [
          "og",
          "oembed",
          "html"
        ],
        "maxLength": 64,
        "type": "string"
      },
      "title": {
        "description": "og:title, else the oEmbed title, else the HTML title.",
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "url": {
        "description": "The page's final URL, after redirects; the bookmark keeps what was saved.",
        "format": "uri",
        "maxLength": 2048,
        "type": "string"
      }
    },
    "required": [
      "url",
      "image",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}

Lexicon Garden

@