programmer/qbittorrent_web_api
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Fix preferences return types

Browse Source
This commit is contained in:
Joel Wachsler 2022-08-05 23:41:30 +00:00
parent 5202a3bfbc
commit 45813813c9
3 changed files with 90 additions and 65 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
qbittorrent-web-api-gen/api-4_1.md
View File

@ -405,7 +405,7 @@ Property | Type | Description
`slow_torrent_inactive_timer` _optional_ | integer | Seconds a torrent should be inactive before considered "slow"
`max_ratio_enabled` _optional_ | bool | True if share ratio limit is enabled
`max_ratio` _optional_ | float | Get the global share ratio limit
`max_ratio_act` _optional_ | integer | Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.
`max_ratio_act` _optional_ | object | max_ratio_act object see table below. Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.
`listen_port` _optional_ | integer | Port for incoming connections
`upnp` _optional_ | bool | True if UPnP/NAT-PMP is enabled
`random_port` _optional_ | bool | True if the port is randomly selected
@ -417,7 +417,7 @@ Property | Type | Description
`max_uploads_per_torrent` _optional_ | integer | Maximum number of upload slots per torrent
`stop_tracker_timeout` _optional_ | integer | Timeout in seconds for a `stopped` announce request to trackers
`enable_piece_extent_affinity` _optional_ | bool | True if the advanced libtorrent option `piece_extent_affinity` is enabled
`bittorrent_protocol` _optional_ | integer | Bittorrent Protocol to use (see list of possible values below)
`bittorrent_protocol` _optional_ | object | bittorrent_protocol object see table below Bittorrent Protocol to use (see list of possible values below)
`limit_utp_rate` _optional_ | bool | True if `[du]l_limit` should be applied to uTP connections; this option is only available in qBittorent built against libtorrent version 0.16.X and higher
`limit_tcp_overhead` _optional_ | bool | True if `[du]l_limit` should be applied to estimated TCP overhead (service data: e.g. packet headers)
`limit_lan_peers` _optional_ | bool | True if `[du]l_limit` should be applied to peers on the LAN
@ -428,13 +428,13 @@ Property | Type | Description
`schedule_from_min` _optional_ | integer | Scheduler starting minute
`schedule_to_hour` _optional_ | integer | Scheduler ending hour
`schedule_to_min` _optional_ | integer | Scheduler ending minute
`scheduler_days` _optional_ | integer | Scheduler days. See possible values here below
`scheduler_days` _optional_ | object | scheduler_days object see table below. See possible values here below
`dht` _optional_ | bool | True if DHT is enabled
`pex` _optional_ | bool | True if PeX is enabled
`lsd` _optional_ | bool | True if LSD is enabled
`encryption` _optional_ | integer | See list of possible values here below
`encryption` _optional_ | object | encryption object see table below. See list of possible values here below
`anonymous_mode` _optional_ | bool | If true anonymous mode will be enabled; read more [here](Anonymous-Mode); this option is only available in qBittorent built against libtorrent version 0.16.X and higher
`proxy_type` _optional_ | integer | See list of possible values here below
`proxy_type` _optional_ | integer | proxy_type object see table below. See list of possible values here below
`proxy_ip` _optional_ | string | Proxy IP address or domain name
`proxy_port` _optional_ | integer | Proxy port
`proxy_peer_connections` _optional_ | bool | True if peer and web seed connections should be proxified; this option will have any effect only in qBittorent built against libtorrent version 0.16.X and higher
@ -469,7 +469,7 @@ Property | Type | Description
`web_ui_https_key_path` _optional_ | string | For API ≥ v2.0.1: Path to SSL keyfile
`web_ui_https_cert_path` _optional_ | string | For API ≥ v2.0.1: Path to SSL certificate
`dyndns_enabled` _optional_ | bool | True if server DNS should be updated dynamically
`dyndns_service` _optional_ | integer | See list of possible values here below
`dyndns_service` _optional_ | integer | dyndns_service object see table below. See list of possible values here below
`dyndns_username` _optional_ | string | Username for DDNS service
`dyndns_password` _optional_ | string | Password for DDNS service
`dyndns_domain` _optional_ | string | Your DDNS domain name
@ -511,10 +511,10 @@ Property | Type | Description
`send_buffer_watermark` _optional_ | integer | Send buffer watermark in KiB
`send_buffer_watermark_factor` _optional_ | integer | Send buffer watermark factor in percent
`socket_backlog_size` _optional_ | integer | Socket backlog size
`upload_choking_algorithm` _optional_ | integer | Upload choking algorithm used (see list of possible values below)
`upload_slots_behavior` _optional_ | integer | Upload slots behavior used (see list of possible values below)
`upload_choking_algorithm` _optional_ | object | upload_choking_algorithm object see table below. Upload choking algorithm used (see list of possible values below)
`upload_slots_behavior` _optional_ | object | upload_slots_behavior object see table below. Upload slots behavior used (see list of possible values below)
`upnp_lease_duration` _optional_ | integer | UPnP lease duration (0: Permanent lease)
`utp_tcp_mixed_mode` _optional_ | integer | μTP-TCP mixed mode algorithm (see list of possible values below)
`utp_tcp_mixed_mode` _optional_ | object | utp_tcp_mixed_mode object see table below. μTP-TCP mixed mode algorithm (see list of possible values below)
Possible values of `scan_dirs`:

99
qbittorrent-web-api-gen/groups.txt
View File

@ -851,14 +851,19 @@
is_list: false,
},
),
Number(
TypeInfo {
name: "max_ratio_act",
description: Some(
"Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
Object(
Object {
type_info: TypeInfo {
name: "max_ratio_act",
description: Some(
"max_ratio_act object see table below. Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
),
is_optional: true,
is_list: false,
},
ref_type: String(
"MaxRatioAct",
),
is_optional: true,
is_list: false,
},
),
Number(
@ -971,14 +976,19 @@
is_list: false,
},
),
Number(
TypeInfo {
name: "bittorrent_protocol",
description: Some(
"Bittorrent Protocol to use (see list of possible values below)",
Object(
Object {
type_info: TypeInfo {
name: "bittorrent_protocol",
description: Some(
"bittorrent_protocol object see table below Bittorrent Protocol to use (see list of possible values below)",
),
is_optional: true,
is_list: false,
},
ref_type: String(
"BittorrentProtocol",
),
is_optional: true,
is_list: false,
},
),
Bool(
@ -1081,14 +1091,19 @@
is_list: false,
},
),
Number(
TypeInfo {
name: "scheduler_days",
description: Some(
"Scheduler days. See possible values here below",
Object(
Object {
type_info: TypeInfo {
name: "scheduler_days",
description: Some(
"scheduler_days object see table below. See possible values here below",
),
is_optional: true,
is_list: false,
},
ref_type: String(
"SchedulerDays",
),
is_optional: true,
is_list: false,
},
),
Bool(
@ -1121,14 +1136,19 @@
is_list: false,
},
),
Number(
TypeInfo {
name: "encryption",
description: Some(
"See list of possible values here below",
Object(
Object {
type_info: TypeInfo {
name: "encryption",
description: Some(
"encryption object see table below. See list of possible values here below",
),
is_optional: true,
is_list: false,
},
ref_type: String(
"Encryption",
),
is_optional: true,
is_list: false,
},
),
Bool(
@ -1145,7 +1165,7 @@
TypeInfo {
name: "proxy_type",
description: Some(
"See list of possible values here below",
"proxy_type object see table below. See list of possible values here below",
),
is_optional: true,
is_list: false,
@ -1495,7 +1515,7 @@
TypeInfo {
name: "dyndns_service",
description: Some(
"See list of possible values here below",
"dyndns_service object see table below. See list of possible values here below",
),
is_optional: true,
is_list: false,
@ -1911,14 +1931,19 @@
is_list: false,
},
),
Number(
TypeInfo {
name: "upload_choking_algorithm",
description: Some(
"Upload choking algorithm used (see list of possible values below)",
Object(
Object {
type_info: TypeInfo {
name: "upload_choking_algorithm",
description: Some(
"upload_choking_algorithm object see table below. Upload choking algorithm used (see list of possible values below)",
),
is_optional: true,
is_list: false,
},
ref_type: String(
"UploadChokingAlgorithm",
),
is_optional: true,
is_list: false,
},
),
Number(

38
qbittorrent-web-api-gen/token_tree.txt
View File

@ -1705,11 +1705,11 @@ TokenTree {
],
},
TableRow {
raw: "`max_ratio_act` _optional_ | integer | Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
raw: "`max_ratio_act` _optional_ | object | max_ratio_act object see table below. Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
columns: [
"max_ratio_act _optional_",
"integer",
"Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
"object",
"max_ratio_act object see table below. Action performed when a torrent reaches the maximum share ratio. See list of possible values here below.",
],
},
TableRow {
@ -1801,11 +1801,11 @@ TokenTree {
],
},
TableRow {
raw: "`bittorrent_protocol` _optional_ | integer | Bittorrent Protocol to use (see list of possible values below)",
raw: "`bittorrent_protocol` _optional_ | object | bittorrent_protocol object see table below Bittorrent Protocol to use (see list of possible values below)",
columns: [
"bittorrent_protocol _optional_",
"integer",
"Bittorrent Protocol to use (see list of possible values below)",
"object",
"bittorrent_protocol object see table below Bittorrent Protocol to use (see list of possible values below)",
],
},
TableRow {
@ -1889,11 +1889,11 @@ TokenTree {
],
},
TableRow {
raw: "`scheduler_days` _optional_ | integer | Scheduler days. See possible values here below",
raw: "`scheduler_days` _optional_ | object | scheduler_days object see table below. See possible values here below",
columns: [
"scheduler_days _optional_",
"integer",
"Scheduler days. See possible values here below",
"object",
"scheduler_days object see table below. See possible values here below",
],
},
TableRow {
@ -1921,11 +1921,11 @@ TokenTree {
],
},
TableRow {
raw: "`encryption` _optional_ | integer | See list of possible values here below",
raw: "`encryption` _optional_ | object | encryption object see table below. See list of possible values here below",
columns: [
"encryption _optional_",
"integer",
"See list of possible values here below",
"object",
"encryption object see table below. See list of possible values here below",
],
},
TableRow {
@ -1937,11 +1937,11 @@ TokenTree {
],
},
TableRow {
raw: "`proxy_type` _optional_ | integer | See list of possible values here below",
raw: "`proxy_type` _optional_ | integer | proxy_type object see table below. See list of possible values here below",
columns: [
"proxy_type _optional_",
"integer",
"See list of possible values here below",
"proxy_type object see table below. See list of possible values here below",
],
},
TableRow {
@ -2217,11 +2217,11 @@ TokenTree {
],
},
TableRow {
raw: "`dyndns_service` _optional_ | integer | See list of possible values here below",
raw: "`dyndns_service` _optional_ | integer | dyndns_service object see table below. See list of possible values here below",
columns: [
"dyndns_service _optional_",
"integer",
"See list of possible values here below",
"dyndns_service object see table below. See list of possible values here below",
],
},
TableRow {
@ -2553,11 +2553,11 @@ TokenTree {
],
},
TableRow {
raw: "`upload_choking_algorithm` _optional_ | integer | Upload choking algorithm used (see list of possible values below)",
raw: "`upload_choking_algorithm` _optional_ | object | upload_choking_algorithm object see table below. Upload choking algorithm used (see list of possible values below)",
columns: [
"upload_choking_algorithm _optional_",
"integer",
"Upload choking algorithm used (see list of possible values below)",
"object",
"upload_choking_algorithm object see table below. Upload choking algorithm used (see list of possible values below)",
],
},
TableRow {