addApiView explenation
This commit is contained in:
@@ -4,7 +4,7 @@ from couchpotato.core.event import addEvent, fireEvent, fireEventAsync
|
|||||||
from couchpotato.core.helpers.encoding import toUnicode, ss
|
from couchpotato.core.helpers.encoding import toUnicode, ss
|
||||||
from couchpotato.core.helpers.request import getParams, jsonified
|
from couchpotato.core.helpers.request import getParams, jsonified
|
||||||
from couchpotato.core.helpers.variable import getExt, mergeDicts, getTitle, \
|
from couchpotato.core.helpers.variable import getExt, mergeDicts, getTitle, \
|
||||||
getImdb, link, symlink
|
getImdb, link, symlink, tryInt
|
||||||
from couchpotato.core.logger import CPLog
|
from couchpotato.core.logger import CPLog
|
||||||
from couchpotato.core.plugins.base import Plugin
|
from couchpotato.core.plugins.base import Plugin
|
||||||
from couchpotato.core.settings.model import Library, File, Profile, Release, \
|
from couchpotato.core.settings.model import Library, File, Profile, Release, \
|
||||||
@@ -25,10 +25,10 @@ class Renamer(Plugin):
|
|||||||
checking_snatched = False
|
checking_snatched = False
|
||||||
|
|
||||||
def __init__(self):
|
def __init__(self):
|
||||||
|
|
||||||
addApiView('renamer.scan', self.scanView, docs = {
|
addApiView('renamer.scan', self.scanView, docs = {
|
||||||
'desc': 'For the renamer to check for new files to rename in a folder',
|
'desc': 'For the renamer to check for new files to rename in a folder',
|
||||||
'params': {
|
'params': {
|
||||||
|
'async': {'desc': 'Optional: Set to 1 if you dont want to fire the renamer.scan asynchronous.'},
|
||||||
'movie_folder': {'desc': 'Optional: The folder of the movie to scan. Keep empty for default renamer folder.'},
|
'movie_folder': {'desc': 'Optional: The folder of the movie to scan. Keep empty for default renamer folder.'},
|
||||||
'downloader' : {'desc': 'Optional: The downloader this movie has been downloaded with'},
|
'downloader' : {'desc': 'Optional: The downloader this movie has been downloaded with'},
|
||||||
'download_id': {'desc': 'Optional: The downloader\'s nzb/torrent ID'},
|
'download_id': {'desc': 'Optional: The downloader\'s nzb/torrent ID'},
|
||||||
|
|||||||
Reference in New Issue
Block a user