WebUI: API documentation file

[sledgehammer999]

This is taken from the wiki file named WebUI API (qBittorrent 4.1) based on https://github.com/qbittorrent/qBittorrent/wiki/WebUI-API-(qBittorrent-4.1)/00539df6f232ef8cda329097513ab67696bbf52f

Github offers very rudimentary controls for wiki edits. It is either "leave it open for every github user" or "restrict it to user with push access to the repo".

For sometime now it is restricted to users with push access.
However, the WebAPI docs have become stale because members have stopped working on them. (members became inactive due to personal reasons).

I can see 2 available solutions:
A. Make the wiki open again. The drawback is that we might get malicious editing again.
B. Move the API docs as a file in the repo and link to it from the wiki. Like it is done with CODING_GUIDELINES.md. The drawback is that anyone wishing to edit the file will have to make a PR, get it reviewed and merged.

I don't know which of the solutions is best. I implement here solution B.
A discussion can be made here for solution A or another one.

[Chocobo1]

Or maybe we can move the wiki to its own repo and give our team members write access to it (and no need for formal approvals in this wiki repo)? So every changes will be at least skimmed through by someone and no malicious content would get in. And no need for formal reviews/suggestions, just accept the changes if they are decent.

However, the WebAPI docs have become stale because members have stopped working on them. (members became inactive due to personal reasons).

I think it's not only WebAPI docs but all wiki content has stalled hence the suggestion of a wiki repo.

[sledgehammer999]

I think it's not only WebAPI docs but all wiki content has stalled hence the suggestion of a wiki repo.

In the repo only the same people that can edit the Wiki now will be able to contribute.
Unless, there are some of those people willing to take care of PRs too.

[github-actions]

This PR is stale because it has been 60 days with no activity. This PR will be automatically closed within 7 days if there is no further activity.

[luzpaz]

JFYI, here is a preview in markdown https://github.com/sledgehammer999/qBittorrent/blob/webapi_docs/src/webui/WebAPI.md

[luzpaz]

Also it looks like the API is missing hte latest torrent creation functionality.

Edit: FWIW I think API documentation should have tight control and therefore migrated to github wiki.

[github-actions]

This PR is stale because it has been 60 days with no activity. This PR will be automatically closed within 7 days if there is no further activity.

[github-actions]

This PR was closed because it has been stalled for some time with no activity.