Co-authored-by: ilike2burnthing <59480337+ilike2burnthing@users.noreply.github.com>
4.9 KiB
BeforeBlock Schema
Cardigann#/definitions/BeforeBlock
HTTP request sent before the download (for example, a 'thank you' page).
| Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|---|---|---|---|---|---|---|---|
| Can be instantiated | No | Unknown status | No | Forbidden | Forbidden | none | schema.json* |
BeforeBlock Type
object (BeforeBlock)
one (and only one) of
BeforeBlock Properties
| Property | Type | Required | Nullable | Defined by |
|---|---|---|---|---|
| path | string |
Optional | cannot be null | Cardigann indexer definition |
| pathselector | object |
Optional | cannot be null | Cardigann indexer definition |
| method | string |
Optional | cannot be null | Cardigann indexer definition |
| inputs | object |
Optional | cannot be null | Cardigann indexer definition |
| queryseparator | string |
Optional | cannot be null | Cardigann indexer definition |
path
Request target.
path
-
is optional
-
Type:
string(Path) -
cannot be null
-
defined in: Cardigann indexer definition
path Type
string (Path)
pathselector
Selector applied to the download page to get the download URL, hash or title.
pathselector
-
is optional
-
Type:
object(SelectorField) -
cannot be null
-
defined in: Cardigann indexer definition
pathselector Type
object (SelectorField)
method
HTTP method: get or post.
method
-
is optional
-
Type:
string(Method) -
cannot be null
-
defined in: Cardigann indexer definition
method Type
string (Method)
inputs
HTTP arguments sent with the request, for example, id: "{{ .DownloadUri.Query.id }}".
inputs
-
is optional
-
Type:
object(Inputs (BeforeBlock)) -
cannot be null
-
defined in: Cardigann indexer definition
inputs Type
object (Inputs (BeforeBlock))
queryseparator
Query string separator. Default: &.
queryseparator
-
is optional
-
Type:
string(Query separator) -
cannot be null
-
defined in: Cardigann indexer definition
queryseparator Type
string (Query separator)