xyz.opnshelf.note Documentation (EN)

main record

A user note about a media item

Record Key tid Timestamp-based ID

Properties

content string Required

Note content

maxLength: 5000 bytes

createdAt string datetime Required

Record creation timestamp

episodeNumber integer Optional

Episode number for episode items

mediaId string Required

TMDB movie ID or show ID

mediaType string Required

Media type

Allowed: movie, show, season, episode

seasonNumber integer Optional

Season number for season/episode items

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "mediaType",
      "mediaId",
      "content",
      "createdAt"
    ],
    "properties": {
      "content": {
        "type": "string",
        "maxLength": 5000,
        "description": "Note content"
      },
      "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 user note about a media item"
}