Add documentation to progress api

2012-09-26 21:01:48 +02:00
parent ed0e54d64d
commit 86bf08cbd4
1 changed files with 3 additions and 0 deletions
@@ -42,6 +42,9 @@ class Searcher(Plugin):
        addApiView('searcher.progress', self.getProgress, docs = {
            'desc': 'Get the progress of current full search',
            'return': {'type': 'object', 'example': """{
    'progress': False || object, total & to_go,
 }"""},
        })
        # Schedule cronjob