xyz.opnshelf.rating

opnshelf.xyz

Documentation

A user's numeric rating for a media item (one per user per media item)

main record

A user's numeric rating for a media item (one per user per media item)

Record Key tid Timestamp-based ID

Properties

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
rating integer Required

Rating from 1 to 10 (maps to 0.5-5.0 stars)

minimum: 1maximum: 10
seasonNumber integer Optional

Season number for season/episode items

View raw schema
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "mediaType",
      "mediaId",
      "rating",
      "createdAt"
    ],
    "properties": {
      "rating": {
        "type": "integer",
        "maximum": 10,
        "minimum": 1,
        "description": "Rating from 1 to 10 (maps to 0.5-5.0 stars)"
      },
      "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's numeric rating for a media item (one per user per media item)"
}

Lexicon Garden

@