search

qbittorrent / qBittorrent

qBittorrent BitTorrent client
https://www.qbittorrent.org
Other
28.47k stars 3.99k forks source link

Wiki: WebUI API page is missing documentation for the `setSpeedLimitsMode` API method #21801

Open ItsAllAboutTheCode opened 2 weeks ago

ItsAllAboutTheCode commented 2 weeks ago

qBittorrent & operating system versions

qBittorrent: 5.0.1 x64

What is the problem?

The WebUI API documentation is missing documentation about the setSpeedLimitsMode added in pull request #17228

The API accepts a mode parameter that can be set to 0 or 1 to explicitly set the speed limits mode state without the need for toggling: https://github.com/qbittorrent/qBittorrent/pull/17228/files#diff-b5c1d1f93bc04466e1c97b92d37596ccb4b5b163c20368d03fada9794bd455e5R129

Steps to reproduce

  1. Navigate to the Transfer Info section of the current qBittorrent WebAPI documentation at https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)#get-alternative-speed-limits-state
  2. Examine that documentation only details the "Get alternative speed limits state" and "Toggle alternative speed limits" APIs.

Additional context

I have verified that invoking a request to the setSpeedLimitMode API work as expected

curl -s --insecure --header "Referer: ${qbittorrent_addr}" -X POST  "${qbittorrent_addr}/api/v2/transfer/setSpeedLimitsMode" -d "mode=1"

Log(s) & preferences file(s)

No log files has been added as this is an issue with the Wiki page