update api docs

This commit is contained in:
nikk gitanes
2024-04-14 03:52:41 +03:00
parent 3cd9f5ef90
commit 3a037c88d8
8 changed files with 44 additions and 41 deletions

View File

@@ -136,7 +136,7 @@
"summary": "Get HTML of magnet links",
"responses": {
"200": {
"description": "Magnet links"
"description": "HTML with Magnet links"
}
}
}
@@ -345,7 +345,7 @@
"summary": "Get / Set server settings",
"parameters": [
{
"description": "Settings request",
"description": "Settings request. Available params for action: get, set, def",
"name": "request",
"in": "body",
"required": true,
@@ -356,7 +356,7 @@
],
"responses": {
"200": {
"description": "Depends on what action has been asked",
"description": "Settings JSON or nothing. Depends on what action has been asked.",
"schema": {
"$ref": "#/definitions/settings.BTSets"
}
@@ -380,17 +380,17 @@
},
"/stat": {
"get": {
"description": "Stat server.",
"description": "Show server and torrents statistics.",
"produces": [
"text/plain"
],
"tags": [
"Pages"
],
"summary": "Stat server",
"summary": "TorrServer Statistics",
"responses": {
"200": {
"description": "Stats"
"description": "TorrServer statistics"
}
}
}
@@ -493,7 +493,7 @@
"tags": [
"API"
],
"summary": "Only one file support",
"summary": "Add .torrent file",
"parameters": [
{
"type": "file",
@@ -545,7 +545,7 @@
},
"/torrents": {
"post": {
"description": "Allow to add, get or set torrents to server. The action depends of what has been asked.",
"description": "Allow to list, add, remove, get, set, drop, wipe torrents on server. The action depends of what has been asked.",
"consumes": [
"application/json"
],
@@ -558,7 +558,7 @@
"summary": "Handle torrents informations",
"parameters": [
{
"description": "Torrent request",
"description": "Torrent request. Available params for action: add, get, set, rem, list, drop, wipe. link required for add, hash required for get, set, rem, drop.",
"name": "request",
"in": "body",
"required": true,
@@ -589,7 +589,7 @@
"summary": "Set / List / Remove viewed torrents",
"parameters": [
{
"description": "Viewed torrent request",
"description": "Viewed torrent request. Available params for action: set, rem, list",
"name": "request",
"in": "body",
"required": true,