github-actions[bot]andilike2burnthing
6ec31d485e
Co-authored-by: ilike2burnthing <59480337+ilike2burnthing@users.noreply.github.com>
7.5 KiB
CategoryMapping Schema
Cardigann#/definitions/CategoryMapping
Maps one tracker category to a Newznab/Torznab category.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | schema.json* |
CategoryMapping Type
object (CategoryMapping)
CategoryMapping Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| id | Merged | Required | cannot be null | Cardigann indexer definition |
| cat | string |
Required | cannot be null | Cardigann indexer definition |
| desc | string |
Optional | cannot be null | Cardigann indexer definition |
| default | boolean |
Optional | cannot be null | Cardigann indexer definition |
id
Tracker-specific category ID. Can be a number or a string.
id
-
is required
-
Type: merged type (ID)
-
cannot be null
-
defined in: Cardigann indexer definition
id Type
merged type (ID)
one (and only one) of
cat
Predefined Newznab/Torznab category name. See the Jackett-Categories wiki page.
cat
-
is required
-
Type:
string(IndexerCategories) -
cannot be null
-
defined in: Cardigann indexer definition
cat Type
string (IndexerCategories)
cat Constraints
enum: the value of this property must be equal to one of the following values:
| Value | Explanation |
|---|---|
"Console" |
|
"Console/NDS" |
|
"Console/PSP" |
|
"Console/Wii" |
|
"Console/XBox" |
|
"Console/XBox 360" |
|
"Console/Wiiware" |
|
"Console/XBox 360 DLC" |
|
"Console/PS3" |
|
"Console/Other" |
|
"Console/3DS" |
|
"Console/PS Vita" |
|
"Console/WiiU" |
|
"Console/XBox One" |
|
"Console/PS4" |
|
"Movies" |
|
"Movies/Foreign" |
|
"Movies/Other" |
|
"Movies/SD" |
|
"Movies/HD" |
|
"Movies/UHD" |
|
"Movies/BluRay" |
|
"Movies/3D" |
|
"Movies/DVD" |
|
"Movies/WEB-DL" |
|
"Audio" |
|
"Audio/MP3" |
|
"Audio/Video" |
|
"Audio/Audiobook" |
|
"Audio/Lossless" |
|
"Audio/Other" |
|
"Audio/Foreign" |
|
"PC" |
|
"PC/0day" |
|
"PC/ISO" |
|
"PC/Mac" |
|
"PC/Mobile-Other" |
|
"PC/Games" |
|
"PC/Mobile-iOS" |
|
"PC/Mobile-Android" |
|
"TV" |
|
"TV/WEB-DL" |
|
"TV/Foreign" |
|
"TV/SD" |
|
"TV/HD" |
|
"TV/UHD" |
|
"TV/Other" |
|
"TV/Sport" |
|
"TV/Anime" |
|
"TV/Documentary" |
|
"XXX" |
|
"XXX/DVD" |
|
"XXX/WMV" |
|
"XXX/XviD" |
|
"XXX/x264" |
|
"XXX/UHD" |
|
"XXX/Pack" |
|
"XXX/ImageSet" |
|
"XXX/Other" |
|
"XXX/SD" |
|
"XXX/WEB-DL" |
|
"Books" |
|
"Books/Mags" |
|
"Books/EBook" |
|
"Books/Comics" |
|
"Books/Technical" |
|
"Books/Other" |
|
"Books/Foreign" |
|
"Other" |
|
"Other/Misc" |
|
"Other/Hashed" |
desc
Tracker category name. If set, it is used for a 1:1 mapping between tracker and Newznab categories.
desc
-
is optional
-
Type:
string(Description) -
cannot be null
-
defined in: Cardigann indexer definition
desc Type
string (Description)
default
Use this category when the search query has no categories. Default: false.
default
-
is optional
-
Type:
boolean(Default) -
cannot be null
-
defined in: Cardigann indexer definition
default Type
boolean (Default)