Repository navigation
Update cardigann docs for v12 - #476
ineednewpajamas wants to merge 1 commit into
Conversation
d2e9ba9 to
6a92f82
Compare
ineednewpajamas
changed the title
bakerboy448
left a comment
bakerboy448
left a comment
There was a problem hiding this comment.
The two filters are only in definition schema v12 (Prowlarr/Indexers#1082); Prowlarr develop has DEFINITION_VERSION = 12 (adaf7730) and master is still 11. Prowlarr uses WebEncoders.Base64UrlEncode/Base64UrlDecode, so the output is URL-safe with no = padding; the encode example needs fixing.
|
|
||
| ## Active Versions | ||
|
|
||
| - [V12 Indexers](https://github.com/Prowlarr/Prowlarr/commit/adaf77308f2a89225c318f6130a990fe1b7048b4) |
There was a problem hiding this comment.
v12 is on develop only (no release yet; master still has DEFINITION_VERSION = 11). Worth saying so here, or adding the release link once one ships.
|
|
||
| ## base64decode | ||
|
|
||
| Converts a *string* that has been base64-encoded for HTTP transmission into a decoded *string*. |
There was a problem hiding this comment.
Suggest: "Decodes a URL-safe base64 string into a string. Padding (=) is optional." "For HTTP transmission" is copied from the html/url filters and does not fit base64.
| selector: button#magnet-button | ||
| attribute: data-link | ||
| filters: | ||
| # input: bWFnbmV0Oj94dD10b3RhbGx5cmVhbG1hZ25ldHVybA== |
There was a problem hiding this comment.
Fine as is: decode accepts padded or unpadded input. Optionally drop the == to match what base64encode produces.
|
|
||
| ## base64encode | ||
|
|
||
| Converts a *string* into an base64-encoded *string* for HTTP transmission. |
There was a problem hiding this comment.
"an base64-encoded" -> "a base64-encoded". Suggest: "Encodes a string as URL-safe base64 (- and _ in place of + and /, no = padding)."
| filters: | ||
| # input: magnet:?xt=totallyrealmagneturl | ||
| - name: base64encode | ||
| # result: bWFnbmV0Oj94dD10b3RhbGx5cmVhbG1hZ25ldHVybA== |
There was a problem hiding this comment.
WebEncoders.Base64UrlEncode strips padding, so the result is bWFnbmV0Oj94dD10b3RhbGx5cmVhbG1hZ25ldHVybA (no ==).
Document new schema filters added in Prowlarr/Indexers#1080