Commit Graph

30 Commits

Author SHA1 Message Date
Yat Ho 5d159e0ee5
docs: fix `torrent-get` `fileStats` and `wanted` docs (#6677)
* docs: fix `torrent-get.wanted` and `torrent-get.fileStats.wanted` docs

* fixup! docs: fix `torrent-get.wanted` and `torrent-get.fileStats.wanted` docs

* docs: add note to differentiate `torrent-get.wanted` and `torrent-get.fileStats.wanted`
2024-03-09 09:05:00 -06:00
Yat Ho 32ef92e7a7
feat: do separate IPv4 and IPv6 port checks in Qt and GTK Client (#6525)
* fix: specify `port-test` ip protocol in response when possible

* feat: IPv4 and IPv6 port test in Qt Client

* feat: shorten timeout of `port-test`

* feat: IPv4 and IPv6 port test in Gtk Client

* chore: housekeeping

* refactor: remove IP protocol error message

* code review: mikedld gtk

* feat: return tag in qt rpc response

* code review: mikedld qt

* feat: move port test button up alongside spin button

* fixup! code review: mikedld gtk

* fixup! code review: mikedld qt

* code review: port status initial text

* feat: decouple ipv4 and ipv6 status updates (GTK)

* feat: decouple ipv4 and ipv6 status updates (Qt)

* code review: unknown protocols are non-pending

Co-authored-by: Mike Gelfand <mikedld@users.noreply.github.com>

* code review: simplify status text when the statuses are the same

* Revert "feat: return tag in qt rpc response"

This reverts commit 2a022c2bb0ee7ddad81f8176839cf0d043422368.

* code review: add translation context for status text (GTK)

* code review: move `port_test_pending_` to `Impl` (GTK)

* fixup! code review: move `port_test_pending_` to `Impl` (GTK)

---------

Co-authored-by: Mike Gelfand <mikedld@users.noreply.github.com>
2024-01-21 16:50:26 -06:00
Yat Ho 3c635cd4e2
fix: exclude `(B/s)` from parameter names (#6448) 2023-12-29 13:22:21 -06:00
Yat Ho 78bb911ea9
docs: add description for torrent action requests (#6302) 2023-11-26 23:05:42 -06:00
Yat Ho 7af71d9695
refactor: pause torrent after verifying if files disappeared (#6277) 2023-11-25 16:20:17 -06:00
Yat Ho adc209d7e8
refactor: RPC `port-test` improvements (#6274) 2023-11-22 23:02:21 -06:00
Yat Ho 6d958bd5fc
feat: do separate IPv4 and IPv6 port checks in WebUI (#5953)
* feat: add `ipProtocol` argument to `port-test` rpc method

* chore: update rpc-spec.md

* feat: split port check UI to IPv4 and IPv6 in webUI

* fix: default `open` to false if cannot get response

* chore: minor docs wording tweak

* chore: make clang-tidy happy

* chore: RPC doc tweaks

* fix: bad merge

* chore: review feedback

Co-authored-by: Charles Kerr <charles@charleskerr.com>

* chore: match quark enum with parameter case

* refactor: use descriptive strings for `ipProtocol`

* chore: update docs

* fixup! refactor: use descriptive strings for `ipProtocol`

* fixup! chore: update docs

---------

Co-authored-by: Charles Kerr <charles@charleskerr.com>
2023-10-24 09:27:28 -04:00
Yat Ho 0c52b710ad
feat: add option to force verify torrent in WebUI (#5981) 2023-10-06 22:52:59 -05:00
tearfur 2a51d4882c
add documentation for `session-id` rpc field (#5863) 2023-08-14 00:31:20 -05:00
Daniel Kamil Kozar c1c27f3da0
Expose files' begin and end pieces via RPC (#5578)
* Expose files' begin and end pieces via RPC

This adds two arguments, `beginPiece` and `endPiece`, for each of the entries
in the `files` array of the RPC's `torrent-`get` method.

The point is to allow RPC clients to display a file's completion progress as
piece-based in addition to byte-based.
2023-06-05 13:15:32 -05:00
Pierre Dubouilh ebfba686b0
feat: sequential download (#4795) 2023-04-14 11:47:54 -05:00
Geoffrey Bonneville c2fb52f51d
docs: add units to immutable properties in RPC doc (#5278) 2023-03-23 15:34:16 -05:00
tearfur 67f6dee04a
Correct minor formatting errors in rpc-spec.md (#5214) 2023-03-13 11:21:48 -05:00
Charles Kerr 2789a8fe69 docs: fix missing method name in 9c436d87d 2023-03-07 21:19:50 -06:00
reardonia 9c436d87dd
fix: torrentGet.wanted RPC breaking change in [4.0.0..4.0.1] (#5170) 2023-03-07 19:44:25 -06:00
Trim21 a623b50ed0
docs: explain default-trackers param format in rpc-spec (#5099) 2023-03-01 13:39:11 -06:00
Max Zettlmeißl f267f95ec1
docs: document previously-undocumented settings (#4971) 2023-02-27 13:40:33 -06:00
Charles Kerr 9bf800e04c
docs: fix RPC documentation error (#4998) 2023-02-22 10:41:11 -06:00
Charles Kerr a650060f3b
docs: deprecate trackerAdd, trackerRemove, trackerReplace RPC (#4699) 2023-01-31 22:53:46 -06:00
Petrprogs ffe307ac1b
Add ready-made RPC wrappers (#3456) 2022-07-17 18:58:43 -05:00
Charles Kerr 61c1a0f1e8
feat: add rpc torrentGet.availability (#3252) 2022-06-11 12:06:07 -05:00
Charles Kerr 0976e6259e
docs: un-deprecate trackerAdd RPC (#3237)
Fixes #3226.
2022-06-08 19:52:37 -05:00
Charles Kerr 6c9c446734
docs: fix documented type of rpc-version-semver (#3209) 2022-06-05 21:17:05 -05:00
maxz 7c76d40a4d
Improve the documentation (#2900)
* Unify the line endings to the Unix style (LF only).

* Fix (where possible) or remove broken links.

* Improve the documentation.

Fix or remove broken links (depending on whether I could find a
working version of the resource).

Change all links to use HTTPS instead of HTTP.

Unify the capitalizations (e.g. uppercase abbreviations, capitalize
proper names and downcase other words).

Fix or improve some parts of the text, clarifying what is meant.

Improve some parts of the program examples (e.g. only use root
privileges where really required).
2022-04-11 12:38:32 -05:00
maxz 8d11f0bc22
Fix typographical errors in the documentation. (#2889) 2022-04-06 17:20:38 -05:00
Matan Ziv-Av c07bac4e19
Limit bandwidth used by a group of torrents (#2761)
* Add support for bandwidth groups. i.e. Bandwidth limit for a (user specified) group of torrents,
2022-03-18 08:11:59 -05:00
Charles Kerr f7d74095ed
docs: convert some wiki markup to markdown (#2692) 2022-02-23 11:00:55 -06:00
kakuhen bee5c1016a
Clarify torrent-add result on duplicate torrents (#2690)
Rewrote a sentence to ensure it's clear that a duplicate torrent error still returns a "success" result over RPC.
2022-02-22 21:59:48 -06:00
Charles Kerr aa657bb0ca Merge branch 'main' into docs/absorb-the-wiki 2022-02-21 11:43:28 -06:00
Charles Kerr 4d5959a752 docs: absorb the wiki 2022-02-21 10:39:27 -06:00
Renamed from extras/rpc-spec.md (Browse further)