net.neodb.defs

neodb.net

Documentation

identifier object

No description available.

Properties

type string Required

Identifier namespace, e.g. isbn, imdb, wikidata.

value string Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "type",
    "value"
  ],
  "properties": {
    "type": {
      "type": "string",
      "description": "Identifier namespace, e.g. isbn, imdb, wikidata."
    },
    "value": {
      "type": "string"
    }
  }
}
rating object

A numeric rating on a 1..max scale.

Properties

max integer Required

No description available.

minimum: 1
value integer Required

No description available.

minimum: 1maximum: 10
View raw schema 
{
  "type": "object",
  "required": [
    "value",
    "max"
  ],
  "properties": {
    "max": {
      "type": "integer",
      "minimum": 1
    },
    "value": {
      "type": "integer",
      "maximum": 10,
      "minimum": 1
    }
  },
  "description": "A numeric rating on a 1..max scale."
}
subject object

Inline reference to a catalog work. NeoDB items are not ATProto records, so a work is referenced by URL (its NeoDB permalink and source site URLs) rather than a strongRef.

Properties

category string Required

Broad media category of the work. Open set; future NeoDB versions may add values.

Known values: book, movie, tv, music, game, podcast, performance, people
cover string uri Optional

Absolute URL of the work's cover image, when present.

identifiers array of refnet.neodb.defs#identifier Optional

Standardized identifiers of the work. Only standard, site-independent identifier types are included (e.g. isbn, imdb, wikidata, asin, gtin, isrc); site-specific ids are conveyed as URLs in sources instead.

sources array of stringuri Optional

URLs of the external source records the work was matched from (IMDB, TMDB, Douban, Goodreads, etc.), referenced by URL rather than raw id.

title string Required

Display title of the work.

maxLength: 2000 bytesmaxGraphemes: 1000 graphemes
type string Required

Specific NeoDB item class (mirrors the NeoDB API schema), distinguishing entities that share a category, e.g. TVShow / TVSeason / TVEpisode, Podcast / PodcastEpisode, Performance / PerformanceProduction, Edition, Movie, Album, Game.

uri string uri Required

Permalink to the work on the originating NeoDB instance.

View raw schema 
{
  "type": "object",
  "required": [
    "uri",
    "category",
    "type",
    "title"
  ],
  "properties": {
    "uri": {
      "type": "string",
      "format": "uri",
      "description": "Permalink to the work on the originating NeoDB instance."
    },
    "type": {
      "type": "string",
      "description": "Specific NeoDB item class (mirrors the NeoDB API schema), distinguishing entities that share a category, e.g. TVShow / TVSeason / TVEpisode, Podcast / PodcastEpisode, Performance / PerformanceProduction, Edition, Movie, Album, Game."
    },
    "cover": {
      "type": "string",
      "format": "uri",
      "description": "Absolute URL of the work's cover image, when present."
    },
    "title": {
      "type": "string",
      "maxLength": 2000,
      "description": "Display title of the work.",
      "maxGraphemes": 1000
    },
    "sources": {
      "type": "array",
      "items": {
        "type": "string",
        "format": "uri"
      },
      "description": "URLs of the external source records the work was matched from (IMDB, TMDB, Douban, Goodreads, etc.), referenced by URL rather than raw id."
    },
    "category": {
      "type": "string",
      "description": "Broad media category of the work. Open set; future NeoDB versions may add values.",
      "knownValues": [
        "book",
        "movie",
        "tv",
        "music",
        "game",
        "podcast",
        "performance",
        "people"
      ]
    },
    "identifiers": {
      "type": "array",
      "items": {
        "ref": "net.neodb.defs#identifier",
        "type": "ref"
      },
      "description": "Standardized identifiers of the work. Only standard, site-independent identifier types are included (e.g. isbn, imdb, wikidata, asin, gtin, isrc); site-specific ids are conveyed as URLs in sources instead."
    }
  },
  "description": "Inline reference to a catalog work. NeoDB items are not ATProto records, so a work is referenced by URL (its NeoDB permalink and source site URLs) rather than a strongRef."
}

Lexicon Garden

@