Api doc base

2012-02-21 17:16:02 +01:00
parent adc755dbd5
commit 7df24643ac
11 changed files with 280 additions and 22 deletions
@@ -19,7 +19,13 @@ class FileManager(Plugin):
        addEvent('file.download', self.download)
        addEvent('file.types', self.getTypes)

-        addApiView('file.cache/<path:filename>', self.showCacheFile, static = True)
+        addApiView('file.cache/<path:filename>', self.showCacheFile, static = True, docs = {
+            'desc': 'Return a file from the cp_data/cache directory',
+            'params': {
+                'filename': {'desc': 'path/filename of the wanted file'}
+            },
+            'return': {'type': 'file'}
+        })

    def showCacheFile(self, filename = ''):