social.showcase.library.item

lexicons.showcase.social

Documentation

Showcase item record

main record

Showcase item record

Record Key tid Timestamp-based ID

Properties

category string Optional

Category/type of item

maxLength: 100 bytes
createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

Item description

maxLength: 3000 bytes
metadata unknown Optional

Freeform metadata (brand, model, condition, datePurchased, etc.)

notes string Optional

Personal notes or story about the item

maxLength: 2000 bytes
schemaVersion integer Optional

Schema version for migrations (defaults to 1 if missing)

Default: 1
tags array of string Required

Tags for discovery (max 20)

maxLength: 20 items
title string Required

Item title

maxLength: 300 bytes
updatedAt string datetime Optional

An RFC 3339 formatted timestamp.

visibility string Required

No description available.

maxLength: 10 bytes
Known values: public, unlisted, private
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "title",
      "tags",
      "images",
      "visibility",
      "createdAt"
    ],
    "properties": {
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "maxLength": 64
        },
        "maxLength": 20,
        "description": "Tags for discovery (max 20)"
      },
      "notes": {
        "type": "string",
        "maxLength": 2000,
        "description": "Personal notes or story about the item"
      },
      "title": {
        "type": "string",
        "maxLength": 300,
        "description": "Item title"
      },
      "images": {
        "type": "array",
        "items": {
          "ref": "social.showcase.defs#itemImage",
          "type": "ref"
        },
        "maxLength": 6,
        "description": "Embedded image blobs (max 6 images, 2000x2000px max, 5MB each)"
      },
      "category": {
        "type": "string",
        "maxLength": 100,
        "description": "Category/type of item"
      },
      "metadata": {
        "type": "unknown",
        "description": "Freeform metadata (brand, model, condition, datePurchased, etc.)"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "updatedAt": {
        "type": "string",
        "format": "datetime"
      },
      "visibility": {
        "type": "string",
        "maxLength": 10,
        "knownValues": [
          "public",
          "unlisted",
          "private"
        ]
      },
      "description": {
        "type": "string",
        "maxLength": 3000,
        "description": "Item description"
      },
      "externalLink": {
        "type": "string",
        "format": "uri",
        "description": "Link to external site"
      },
      "schemaVersion": {
        "type": "integer",
        "default": 1,
        "description": "Schema version for migrations (defaults to 1 if missing)"
      }
    }
  },
  "description": "Showcase item record"
}

Lexicon Garden

@