qbittorrent / qBittorrent

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

missing api documentation on login #10687

Open divinity76 opened 5 years ago

divinity76 commented 5 years ago

Please provide the following information

qBittorrent version and Operating System

irrelevant

If on linux, libtorrent and Qt version

irrelevant

What is the problem

the api documentation does not state how to differentiate between a "successful login" and a "invalid login credentials supplied"

What is the expected behavior

the documentation should state how a programmer can differentiate between a successful login vs invalid credentials supplied.

Steps to reproduce

read the Login section at https://github.com/qbittorrent/qBittorrent/wiki/Web-API-Documentation#login

Extra info(if any)

testing shows that it will say "ok." on successful login, and "Fails." if the username/password is wrong. the documentation should probably state this.

.. also in my opinion, since we're already using HTTP response codes for saying "User's IP is banned for too many failed login attempts", we should also use the appropriate HTTP response code for invalid credentials, which is HTTP 403 Forbidden, but that is a feature request which probably belongs in a different issue altogether.

Noorquacker commented 4 years ago

This is the first issue opened in this family of issues containing #10688 and #11360.

qBittorrent changed the api and didn't update the documentation Never mind, I bookmarked the old documentation and didn't read the new one.