github-actions[bot]andilike2burnthing
6ec31d485e
Co-authored-by: ilike2burnthing <59480337+ilike2burnthing@users.noreply.github.com>
5.3 KiB
Caps Schema
Cardigann#/definitions/Caps
Capabilities of the indexer: category mappings and supported Torznab search modes.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | schema.json* |
Caps Type
object (Caps)
one (and only one) of
Caps Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| categories | object |
Optional | cannot be null | Cardigann indexer definition |
| categorymappings | array |
Optional | cannot be null | Cardigann indexer definition |
| modes | object |
Required | cannot be null | Cardigann indexer definition |
| allowrawsearch | boolean |
Optional | cannot be null | Cardigann indexer definition |
| allowtvsearchimdb | boolean |
Optional | cannot be null | Cardigann indexer definition |
categories
Simple mapping of tracker category ID to Newznab category. Use either this or categorymappings.
categories
-
is optional
-
Type:
object(Categories (Caps)) -
cannot be null
-
defined in: Cardigann indexer definition
categories Type
object (Categories (Caps))
categorymappings
List of tracker-to-Newznab category mappings. Use either this or categories.
categorymappings
-
is optional
-
Type:
object[](CategoryMapping) -
cannot be null
-
defined in: Cardigann indexer definition
categorymappings Type
object[] (CategoryMapping)
categorymappings Constraints
unique items: all items in this array must be unique. Duplicates are not allowed.
modes
Torznab search modes and the query parameters the tracker supports for each. Most apps calling Jackett depend on these being correct.
modes
-
is required
-
Type:
object(Modes) -
cannot be null
-
defined in: Cardigann indexer definition
modes Type
object (Modes)
allowrawsearch
Enable raw search. See Jackett issue 8246.
allowrawsearch
-
is optional
-
Type:
boolean(Allow raw search) -
cannot be null
-
defined in: Cardigann indexer definition
allowrawsearch Type
boolean (Allow raw search)
allowtvsearchimdb
Allow imdbid in tv-search. See Jackett issue 16412.
allowtvsearchimdb
-
is optional
-
Type:
boolean(Allow TV search by IMDb ID) -
cannot be null
-
defined in: Cardigann indexer definition
allowtvsearchimdb Type
boolean (Allow TV search by IMDb ID)