series.json schema (version 1.0.1)
evilhero edited this page Jun 25, 2021
·
6 revisions
{
"$id": "https://github.com/mylar3/series_schema.json",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"title": "series metadata",
"type": "object",
"properties": {
"version": {
"type": "string",
"description": "schema versioning for 1.0.1 (value is set at `1.0.1`)"
},
"metadata: {
"type": "object",
"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": "int",
"description": "ComicVine comicid"
},
"year": {
"type": "int",
"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": ["int", "null"],
"description": volume of the series in relation to other titles (this can be either numerical or the series year)"
},
"booktype": {
"type": "string",
"description": "booktype of the series (Print, OneShot, TPB or GN)"
},
"age_rating": {
"type": ["string", "null"],
"description": "age rating of the series as taken from within Mylar"
},
"collects": {
"type": ["array", "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": "int",
"description": "total issues in the series up until this point in time"
},
"publication_run": {
"type": "string",
"description": "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'"
}
}
}
}
- changed
metadata
from an object of array to just an object. - changed
year
,comicid
,volume
toint
type. - added
age_rating
to properties ofmetadata
object. - added
version
properties to root of object. - correct some incorrect formatting of schema due to changes & being incorrect.
Getting Started
- Installation Instructions
- Usage
- FAQ
- Tips and Tricks
- Upgrading from the evilhero version
- Mylar as a service (Windows)
- Auto-Backups
Post-Processing
Helping us to help you
Troubleshooting
- Common Errors / Problems
- Where Mylar gets the metadata from
- The mismatched status
- Moving to a new filesystem
- Folder and File formats
- API Documentation
series.json
Contributing