Skip to content

series.json schema (version 1.0)

evilhero edited this page Jun 7, 2021 · 1 revision
{
 "$id": "https://github.com/mylar3/series_schema.json",
 "$schema": "https://json-schema.org/draft/2020-12/schema",
 "title": "series metadata",
 "type": "object",
 "metadata: {
   "properties": {
     "type": {
       "type": "string",
       "description": "comicSeries"
     },
     "publisher": {
       "type": "string",
       "description": "publisher name"
     },
     "imprint": {
        "type": ["string", "null"],
        "description": "name of imprint while under publisher"
     },
     "name": {
        "type": "string",
        "description": "title of series"
     },
     "comicid": {
        "type": "string",
        "description": "ComicVine comicid"
     },
     "year": {
        "type": "string",
        "description": "year the series started (publication start)"
     },
     "description_text": {
        "type": "string",
        "description": "description taken from Mylar (un-edited if it comes from CV) with no line breaks, carriage returns, etc"
     },
     "description_formatted": {
        "type": ["string", "null"],
        "description": "same as above, only contains line breaks, carriage returns, etc."
     },
     "volume": {
        "type": ["string", "null"],
        "description": volume of the series in relation to other titles (this is in the vX styling, NOT with year - ie. vXXXX)"
     },
     "booktype": {
        "type": "string",
        "description": "booktype of the series (Print, OneShot, TPB or GN)"
     },
     "collects": {
        "type": ["object", "null"],
        "description": "TPB or GN may collect various single issues/series. This will list them here":
        "properties": {
          "series": {
            "type": "string",
            "description": "title of series"
          },
          "comicid": {
            "type": "string",
            "description": "CV ComicID of series"
          },
          "issueid": {
            "type": "string",
            "description": "CV IssueID of single issue (not valid if multiple issues)"
          },
          "issues": {
            "type": "string",
            "description": "listing of issue numbers present pertaining to related comicid in collection"
          }
        }
     },
     "comicImage": {
        "type": "string",
        "description": "image url link pointing to CV image of series cover (usually issue #1)"
     },
     "total_issues: {
        "type": "string",
        "description": "total issues in the series up until this point in time"
     },
     "publication_run": {
        "type": "string",
        "description": "the start and end of the series in 'Month Year - Month Year' format. If series Status is Continuing, the end value is 'Present'"
     },
     "status": {
        "type": "string",
        "description": "Either 'Continuing' or 'Ended'"
     }
   }
 }
}

version 1.0

  • initial schema released.