garden.lexicon.nourishing-earthworm.crepeList Documentation (EN)

main record

A list of titles in crepe's private library: the watchlist or a user list.

Record Key tid Timestamp-based ID

Properties

autoAddMinRating integer Optional

titles rated at or above this (half stars times two) are added automatically

minimum: 1maximum: 10

createdAt string datetime Required

An RFC 3339 formatted timestamp.

description string Optional

No description available.

maxLength: 3000 bytesmaxGraphemes: 300 graphemes

listType string Required

No description available.

Known values: watchlist, list

locked boolean Optional

hide the list from add-to-list pickers

Default: false

mediaType string Optional

deprecated, read but no longer written; use mediaTypes. restrict the list to films or to shows; absent means both

Known values: movie, tv

mediaTypes array of string Optional

the kinds of title the list takes; absent means films and shows. special is standup specials, a subset of movies

maxLength: 8 items

mirror ref #mirror Optional

This list follows a public Letterboxd or IMDb list, one way. The source is authoritative.

name string Required

No description available.

maxLength: 1000 bytesmaxGraphemes: 100 graphemes

ordered boolean Optional

No description available.

plexCollection ref #plexCollection Optional

Mirror this list, one way, into a collection on a Plex Media Server. The server owner grants which collections a user may bind.

shareId string Optional

random url-safe id in the share link of an unlisted or public list; minted when the list first leaves private, dropped when it returns to private

maxLength: 32 bytesminLength: 16 bytes

showProgress boolean Optional

show a watched-count progress bar on the list page

Default: false

showReviews boolean Optional

show the list author's rating and review on each row of the list page

Default: false

sort string Optional

how the list orders its titles: custom (by hand, by each item's position) or by when the author last watched each title, its release date, its title, when it was added, or the author's rating. absent means custom

Known values: custom, lastWatched, release, title, added, rating

Default: custom

sortDirection string Optional

which way sort runs; absent means the sort's natural way (newest, most recent or highest first; titles a to z). ignored when sort is custom

Known values: asc, desc

stamps unknown Optional

Field group to hybrid logical clock stamp.

tags array of string Optional

No description available.

maxLength: 50 items

updatedAt string datetime Required

An RFC 3339 formatted timestamp.

visibility string Optional

who can see the list: private (only the owner), unlisted (a public page, not indexed, reachable by its share link) or public (a public page, indexed, with the records copied into the public repo). absent means private. a reader keeps a value it does not know rather than treating the list as private

Known values: private, unlisted, public

Default: private

View raw schema

{
  "description": "A list of titles in crepe's private library: the watchlist or a user list.",
  "key": "tid",
  "record": {
    "properties": {
      "autoAddMinRating": {
        "description": "titles rated at or above this (half stars times two) are added automatically",
        "maximum": 10,
        "minimum": 1,
        "type": "integer"
      },
      "createdAt": {
        "format": "datetime",
        "type": "string"
      },
      "description": {
        "maxGraphemes": 300,
        "maxLength": 3000,
        "type": "string"
      },
      "listType": {
        "knownValues": [
          "watchlist",
          "list"
        ],
        "type": "string"
      },
      "locked": {
        "default": false,
        "description": "hide the list from add-to-list pickers",
        "type": "boolean"
      },
      "mediaType": {
        "description": "deprecated, read but no longer written; use mediaTypes. restrict the list to films or to shows; absent means both",
        "knownValues": [
          "movie",
          "tv"
        ],
        "type": "string"
      },
      "mediaTypes": {
        "description": "the kinds of title the list takes; absent means films and shows. special is standup specials, a subset of movies",
        "items": {
          "knownValues": [
            "movie",
            "tv",
            "special"
          ],
          "type": "string"
        },
        "maxLength": 8,
        "type": "array"
      },
      "mirror": {
        "description": "This list follows a public Letterboxd or IMDb list, one way. The source is authoritative.",
        "ref": "#mirror",
        "type": "ref"
      },
      "name": {
        "maxGraphemes": 100,
        "maxLength": 1000,
        "type": "string"
      },
      "ordered": {
        "type": "boolean"
      },
      "plexCollection": {
        "description": "Mirror this list, one way, into a collection on a Plex Media Server. The server owner grants which collections a user may bind.",
        "ref": "#plexCollection",
        "type": "ref"
      },
      "shareId": {
        "description": "random url-safe id in the share link of an unlisted or public list; minted when the list first leaves private, dropped when it returns to private",
        "maxLength": 32,
        "minLength": 16,
        "type": "string"
      },
      "showProgress": {
        "default": false,
        "description": "show a watched-count progress bar on the list page",
        "type": "boolean"
      },
      "showReviews": {
        "default": false,
        "description": "show the list author's rating and review on each row of the list page",
        "type": "boolean"
      },
      "sort": {
        "default": "custom",
        "description": "how the list orders its titles: custom (by hand, by each item's position) or by when the author last watched each title, its release date, its title, when it was added, or the author's rating. absent means custom",
        "knownValues": [
          "custom",
          "lastWatched",
          "release",
          "title",
          "added",
          "rating"
        ],
        "type": "string"
      },
      "sortDirection": {
        "description": "which way sort runs; absent means the sort's natural way (newest, most recent or highest first; titles a to z). ignored when sort is custom",
        "knownValues": [
          "asc",
          "desc"
        ],
        "type": "string"
      },
      "stamps": {
        "description": "Field group to hybrid logical clock stamp.",
        "type": "unknown"
      },
      "tags": {
        "items": {
          "maxLength": 640,
          "type": "string"
        },
        "maxLength": 50,
        "type": "array"
      },
      "updatedAt": {
        "format": "datetime",
        "type": "string"
      },
      "visibility": {
        "default": "private",
        "description": "who can see the list: private (only the owner), unlisted (a public page, not indexed, reachable by its share link) or public (a public page, indexed, with the records copied into the public repo). absent means private. a reader keeps a value it does not know rather than treating the list as private",
        "knownValues": [
          "private",
          "unlisted",
          "public"
        ],
        "type": "string"
      }
    },
    "required": [
      "name",
      "listType",
      "createdAt",
      "updatedAt"
    ],
    "type": "object"
  },
  "type": "record"
}

mirror object

No description available.

Properties

fetchedAt string datetime Required

When the source was last read.

source string Required

No description available.

Known values: letterboxd, imdb

url string Required

Public list URL as the user gave it.

maxLength: 2000 bytes

View raw schema

{
  "properties": {
    "fetchedAt": {
      "description": "When the source was last read.",
      "format": "datetime",
      "type": "string"
    },
    "source": {
      "knownValues": [
        "letterboxd",
        "imdb"
      ],
      "type": "string"
    },
    "url": {
      "description": "Public list URL as the user gave it.",
      "maxLength": 2000,
      "type": "string"
    }
  },
  "required": [
    "url",
    "source",
    "fetchedAt"
  ],
  "type": "object"
}

plexCollection object

No description available.

Properties

name string Required

Collection title on the server, matched case-insensitively.

maxLength: 200 bytes

server string Optional

Plex machineIdentifier of the server. Absent means crepe's default server.

maxLength: 128 bytes

View raw schema

{
  "properties": {
    "name": {
      "description": "Collection title on the server, matched case-insensitively.",
      "maxLength": 200,
      "type": "string"
    },
    "server": {
      "description": "Plex machineIdentifier of the server. Absent means crepe's default server.",
      "maxLength": 128,
      "type": "string"
    }
  },
  "required": [
    "name"
  ],
  "type": "object"
}