Co-authored-by: ilike2burnthing <59480337+ilike2burnthing@users.noreply.github.com>
11 KiB
RowsBlock Schema
Cardigann#/definitions/RowsBlock
Selects the result rows. Each row is then parsed with the fields block.
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | schema.json* |
RowsBlock Type
object (RowsBlock)
RowsBlock Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| after | integer |
Optional | cannot be null | Cardigann indexer definition |
| dateheaders | Merged | Optional | cannot be null | Cardigann indexer definition |
| selector | string |
Optional | cannot be null | Cardigann indexer definition |
| attribute | string |
Optional | cannot be null | Cardigann indexer definition |
| optional | boolean |
Optional | cannot be null | Cardigann indexer definition |
| multiple | boolean |
Optional | cannot be null | Cardigann indexer definition |
| missingAttributeEqualsNoResults | boolean |
Optional | cannot be null | Cardigann indexer definition |
| case | object |
Optional | cannot be null | Cardigann indexer definition |
| remove | string |
Optional | cannot be null | Cardigann indexer definition |
| text | Merged | Optional | cannot be null | Cardigann indexer definition |
| filters | array |
Optional | cannot be null | Cardigann indexer definition |
| count | Merged | Optional | cannot be null | Cardigann indexer definition |
after
Row merging. Merge this many following elements into each row, for sites that use several elements per torrent (for example, collapsed rows).
after
-
is optional
-
Type:
integer(After) -
cannot be null
-
defined in: Cardigann indexer definition
after Type
integer (After)
dateheaders
Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.
dateheaders
-
is optional
-
Type:
object(SelectorBlock) -
cannot be null
-
defined in: Cardigann indexer definition
dateheaders Type
object (SelectorBlock)
all of
selector
Selector for the result rows. For JSON, $ refers to the root object.
selector
-
is optional
-
Type:
string(Selector) -
cannot be null
-
defined in: Cardigann indexer definition
selector Type
string (Selector)
attribute
JSON/XML only. Sub-element holding the torrents, when they are nested in each row.
attribute
-
is optional
-
Type:
string(Attribute) -
cannot be null
-
defined in: Cardigann indexer definition
attribute Type
string (Attribute)
optional
Do not fail if the selector does not match.
optional
-
is optional
-
Type:
boolean(Optional) -
cannot be null
-
defined in: Cardigann indexer definition
optional Type
boolean (Optional)
multiple
JSON/XML only. Each row holds several torrents (for example, one title with several releases).
multiple
-
is optional
-
Type:
boolean(Multiple) -
cannot be null
-
defined in: Cardigann indexer definition
multiple Type
boolean (Multiple)
missingAttributeEqualsNoResults
JSON/XML only. Return zero results instead of an error when attribute is missing.
missingAttributeEqualsNoResults
-
is optional
-
Type:
boolean(Missing attribute equals no results) -
cannot be null
-
defined in: Cardigann indexer definition
missingAttributeEqualsNoResults Type
boolean (Missing attribute equals no results)
case
Selector: value pairs. The value of the first matching selector is used.
case
-
is optional
-
Type:
object(Case (RowsBlock)) -
cannot be null
-
defined in: Cardigann indexer definition
case Type
object (Case (RowsBlock))
remove
Selector for elements to remove from each row.
remove
-
is optional
-
Type:
string(Remove) -
cannot be null
-
defined in: Cardigann indexer definition
remove Type
string (Remove)
text
Fixed value, or a template.
text
-
is optional
-
Type: merged type (Text)
-
cannot be null
-
defined in: Cardigann indexer definition
text Type
merged type (Text)
one (and only one) of
filters
Row filters, for example, andmatch or strdump.
filters
-
is optional
-
Type:
object[](RowFilterBlock) -
cannot be null
-
defined in: Cardigann indexer definition
filters Type
object[] (RowFilterBlock)
count
Extracts a value from a response using a CSS selector (HTML) or path (JSON/XML), then applies case, remove and filters.
count
-
is optional
-
Type:
object(SelectorBlock) -
cannot be null
-
defined in: Cardigann indexer definition
count Type
object (SelectorBlock)
all of