xyz.opnshelf.library.item

opnshelf.xyz

Documentation

A film a user owns in a given format (their Library). No parent record — the Library is the umbrella over these items.

main record

A film a user owns in a given format (their Library). No parent record — the Library is the umbrella over these items.

Record Key tid Timestamp-based ID

Properties

boxSet string Optional

Optional named box set this item belongs to

createdAt string datetime Required

Record creation timestamp

episodeNumber integer Optional

Episode number for episode items

format string Required

The medium the item is owned in

Allowed: digital, bluray, bluray4k, dvd
mediaId string Required

TMDB movie ID or show ID

mediaType string Required

Media type

Allowed: movie, show, season, episode
notes string Optional

Optional user notes about the owned item

seasonNumber integer Optional

Season number for season/episode items

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "mediaType",
      "mediaId",
      "format",
      "createdAt"
    ],
    "properties": {
      "notes": {
        "type": "string",
        "description": "Optional user notes about the owned item"
      },
      "boxSet": {
        "type": "string",
        "description": "Optional named box set this item belongs to"
      },
      "format": {
        "enum": [
          "digital",
          "bluray",
          "bluray4k",
          "dvd"
        ],
        "type": "string",
        "description": "The medium the item is owned in"
      },
      "mediaId": {
        "type": "string",
        "description": "TMDB movie ID or show ID"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Record creation timestamp"
      },
      "mediaType": {
        "enum": [
          "movie",
          "show",
          "season",
          "episode"
        ],
        "type": "string",
        "description": "Media type"
      },
      "seasonNumber": {
        "type": "integer",
        "description": "Season number for season/episode items"
      },
      "episodeNumber": {
        "type": "integer",
        "description": "Episode number for episode items"
      }
    }
  },
  "description": "A film a user owns in a given format (their Library). No parent record — the Library is the umbrella over these items."
}

Lexicon Garden

@