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

proxy_type returns string, instead of integer #20027

Closed
George-Miao opened this issue Nov 26, 2023 · 6 comments
Closed

proxy_type returns string, instead of integer #20027

George-Miao opened this issue Nov 26, 2023 · 6 comments
Labels
Documentation WebAPI WebAPI-related issues/changes

Comments

@George-Miao
Copy link

qBittorrent & operating system versions

qBittorrent: 4.6.1 x64
Operating System: Arch Linux

What is the problem?

When requesting /api/v2/app/preferences, the return type for proxy_type field is string, unlike what's described in api doc, which says it's an integer.

Steps to reproduce

Freshly install v4.6.1, turn on the API, then GET /api/v2/app/preferences.

Additional context

No response

Log(s) & preferences file(s)

No response

@glassez
Copy link
Member

glassez commented Nov 26, 2023

The documentation is outdated and there is no one to update it.

@glassez glassez added Documentation WebAPI WebAPI-related issues/changes labels Nov 26, 2023
@luzpaz
Copy link
Contributor

luzpaz commented Nov 29, 2023

I can quickly update it, is that OK @glassez ?

@luzpaz luzpaz added the Waiting info Waiting for participants to supply more info/fulfill template requirements label Nov 29, 2023
@glassez
Copy link
Member

glassez commented Nov 29, 2023

I can quickly update it, is that OK @glassez ?

Ok.
Note that it is necessary to mention the API version in which this was changed.

@luzpaz
Copy link
Contributor

luzpaz commented Nov 29, 2023

Is there an example of how it's been done in the past ?

@glassez
Copy link
Member

glassez commented Nov 29, 2023

Is there an example of how it's been done in the past ?

At least there is Changes section in wiki for this purposes.

@glassez
Copy link
Member

glassez commented Nov 29, 2023

Is there an example of how it's been done in the past ?

At least there is Changes section in wiki for this purposes.

Also, in the description itself, you can leave both options, old and new, and mark that the old one exists until version 2.x.y, and the new one - since version 2.x.y.

@xavier2k6 xavier2k6 removed the Waiting info Waiting for participants to supply more info/fulfill template requirements label Sep 17, 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

4 participants