work.lexical.collection.item

{
  "id": "work.lexical.collection.item",
  "defs": {
    "main": {
      "key": "tid",
      "type": "record",
      "record": {
        "type": "object",
        "required": [
          "collection",
          "work"
        ],
        "properties": {
          "note": {
            "type": "string",
            "maxLength": 1000,
            "description": "An optional note about this item in the collection.",
            "maxGraphemes": 4000
          },
          "work": {
            "type": "string",
            "format": "at-uri",
            "required": true,
            "maxLength": 2048,
            "description": "AT URI of the work. Must reference a work.lexical.work or work.lexical.work.* record."
          },
          "position": {
            "type": "integer",
            "minimum": 1,
            "description": "1-indexed position of this item in the collection. Meaningful when the collection is ranked."
          },
          "collection": {
            "type": "string",
            "format": "at-uri",
            "required": true,
            "maxLength": 2048,
            "description": "AT URI of the collection this item belongs to."
          },
          "noteFacets": {
            "type": "array",
            "items": {
              "ref": "social.lexical.richtext.facet",
              "type": "ref",
              "nullable": false
            },
            "nullable": false,
            "required": false,
            "description": "Facets for rich text in the note. Clients must accept but may ignore any or all facets."
          },
          "containsSpoilers": {
            "type": "boolean",
            "description": "If true, apps should obscure the note until the user chooses to reveal it."
          }
        }
      },
      "description": "A record linking a work to a collection."
    }
  },
  "$type": "com.atproto.lexicon.schema",
  "lexicon": 1
}