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

@@ -27,11 +27,11 @@ type setsReqJS struct {
//
// @Tags API
//
// @Param request body setsReqJS true "Settings request"
// @Param request body setsReqJS true "Settings request. Available params for action: get, set, def"
//
// @Accept json
// @Produce json
// @Success 200 {object} sets.BTSets "Depends on what action has been asked"
// @Success 200 {object} sets.BTSets "Settings JSON or nothing. Depends on what action has been asked."
// @Router /settings [post]
func settings(c *gin.Context) {
var req setsReqJS

View File

@@ -30,11 +30,11 @@ type torrReqJS struct {
// torrents godoc
//
// @Summary Handle torrents informations
// @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.
//
// @Tags API
//
// @Param request body torrReqJS true "Torrent request"
// @Param request body torrReqJS true "Torrent request. Available params for action: add, get, set, rem, list, drop, wipe. link required for add, hash required for get, set, rem, drop."
//
// @Accept json
// @Produce json

View File

@@ -12,7 +12,7 @@ import (
// torrentUpload godoc
//
// @Summary Only one file support
// @Summary Add .torrent file
// @Description Only one file support.
//
// @Tags API

View File

@@ -25,7 +25,7 @@ type viewedReqJS struct {
//
// @Tags API
//
// @Param request body viewedReqJS true "Viewed torrent request"
// @Param request body viewedReqJS true "Viewed torrent request. Available params for action: set, rem, list"
//
// @Accept json
// @Produce json