mirror of
https://github.com/Ernous/TorrServerJellyfin.git
synced 2025-12-19 21:46:11 +05:00
update api docs
This commit is contained in:
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -12,7 +12,7 @@ import (
|
||||
|
||||
// torrentUpload godoc
|
||||
//
|
||||
// @Summary Only one file support
|
||||
// @Summary Add .torrent file
|
||||
// @Description Only one file support.
|
||||
//
|
||||
// @Tags API
|
||||
|
||||
@@ -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
|
||||
|
||||
Reference in New Issue
Block a user