work.lexical.collection

lexical.work

Documentation

A named, optionally ranked collection of works.

main record

A named, optionally ranked collection of works.

Record Key tid Timestamp-based ID

Properties

description string Optional

An optional description of the collection.

maxLength: 2048 bytesmaxGraphemes: 8192 graphemes
facets array of ref social.lexical.richtext.facet Optional

Facets for rich text in the description. Clients must accept but may ignore any or all facets.

listType string Optional

Optional category for the collection. Known values are non-exhaustive; clients must accept but may ignore unknown types.

maxLength: 64 bytesmaxGraphemes: 256 graphemes
Known values: watchlist, watched, favorites, list
name string Required

The name of the collection.

maxLength: 256 bytesmaxGraphemes: 1024 graphemes
ranked boolean Optional

If true, item position values within the collection are meaningful.

tags array of string Optional

Optional tags for the collection.

maxLength: 16 items
View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name"
    ],
    "properties": {
      "name": {
        "type": "string",
        "required": true,
        "maxLength": 256,
        "description": "The name of the collection.",
        "maxGraphemes": 1024
      },
      "tags": {
        "type": "array",
        "items": {
          "type": "string",
          "nullable": false,
          "maxLength": 64,
          "maxGraphemes": 256
        },
        "maxLength": 16,
        "description": "Optional tags for the collection."
      },
      "facets": {
        "type": "array",
        "items": {
          "ref": "social.lexical.richtext.facet",
          "type": "ref",
          "nullable": false
        },
        "nullable": false,
        "required": false,
        "description": "Facets for rich text in the description. Clients must accept but may ignore any or all facets."
      },
      "ranked": {
        "type": "boolean",
        "description": "If true, item position values within the collection are meaningful."
      },
      "listType": {
        "type": "string",
        "maxLength": 64,
        "description": "Optional category for the collection. Known values are non-exhaustive; clients must accept but may ignore unknown types.",
        "knownValues": [
          "watchlist",
          "watched",
          "favorites",
          "list"
        ],
        "maxGraphemes": 256
      },
      "description": {
        "type": "string",
        "maxLength": 2048,
        "description": "An optional description of the collection.",
        "maxGraphemes": 8192
      }
    }
  },
  "description": "A named, optionally ranked collection of works."
}

Lexicon Garden

@