Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
ItsAllAboutTheCode opened this issue Nov 8, 2024 · 0 comments
Labels
Documentation WebAPI WebAPI-related issues/changes

Comments

@ItsAllAboutTheCode
Copy link

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

@ItsAllAboutTheCode ItsAllAboutTheCode changed the title Wiki WebUI API page is missing documentation for the setSpeedLimitsMode APImethod Wiki: WebUI API page is missing documentation for the setSpeedLimitsMode API method Nov 8, 2024
@thalieht thalieht added Documentation WebAPI WebAPI-related issues/changes labels Nov 8, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Documentation WebAPI WebAPI-related issues/changes
Projects
None yet
Development

No branches or pull requests

2 participants