app.offprint.block.webBookmark Documentation (EN)

main object

No description available.

Properties

description string Optional

Page description/excerpt

maxGraphemes: 1000 graphemes

href string uri Required

The URL of the bookmarked page

preview blob Optional

Open Graph image for the page

maxSize: 1.0 MB

siteName string Optional

Name of the website

maxGraphemes: 100 graphemes

title string Required

Page title

maxGraphemes: 300 graphemes

View raw schema

{
  "type": "object",
  "required": [
    "href",
    "title"
  ],
  "properties": {
    "href": {
      "type": "string",
      "format": "uri",
      "required": true,
      "description": "The URL of the bookmarked page"
    },
    "title": {
      "type": "string",
      "required": true,
      "description": "Page title",
      "maxGraphemes": 300
    },
    "preview": {
      "type": "blob",
      "accept": [
        "image/*"
      ],
      "maxSize": 1000000,
      "description": "Open Graph image for the page"
    },
    "siteName": {
      "type": "string",
      "description": "Name of the website",
      "maxGraphemes": 100
    },
    "description": {
      "type": "string",
      "description": "Page description/excerpt",
      "maxGraphemes": 1000
    }
  }
}