cafe.hypertext.share Documentation (EN)

main record

Shared content by a user

Record Key any Any valid record key

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Required

Content description (preferably auto fetched)

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

name string Required

Content name (preferably auto fetched)

maxLength: 640 bytesminLength: 1 bytesmaxGraphemes: 64 graphemes

note string Optional

User note

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

type string Required

Content type

maxLength: 64 bytesminLength: 1 bytesmaxGraphemes: 64 graphemes

Allowed: book, website

uri string Required

Content URI (eg: https:// for sites, urn:isbn:// for books)

maxLength: 640 bytesminLength: 1 bytesmaxGraphemes: 64 graphemes

View raw schema

{
  "description": "Shared content by a user",
  "key": "any",
  "record": {
    "properties": {
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "description": "Content description (preferably auto fetched)",
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "name": {
        "description": "Content name (preferably auto fetched)",
        "maxGraphemes": 64,
        "maxLength": 640,
        "minLength": 1,
        "type": "string"
      },
      "note": {
        "description": "User note",
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "type": {
        "description": "Content type",
        "enum": [
          "book",
          "website"
        ],
        "maxGraphemes": 64,
        "maxLength": 64,
        "minLength": 1,
        "type": "string"
      },
      "uri": {
        "description": "Content URI (eg: https:// for sites, urn:isbn:// for books)",
        "maxGraphemes": 64,
        "maxLength": 640,
        "minLength": 1,
        "type": "string"
      }
    },
    "required": [
      "name",
      "description",
      "type",
      "uri",
      "createdAt"
    ],
    "type": "object"
  },
  "type": "record"
}