diff --git a/ox/django/api/actions.py b/ox/django/api/actions.py index 6b44777..a3ecb0f 100644 --- a/ox/django/api/actions.py +++ b/ox/django/api/actions.py @@ -55,27 +55,21 @@ class ApiActions(dict): def api(request, data): ''' - returns list of all known api actions - param data { - docs: bool - } - if docs is true, action properties contain docstrings - return { - status: {'code': int, 'text': string}, - data: { - actions: { - 'api': { - cache: true, - doc: 'recursion' - }, - 'hello': { - cache: true, - .. - } - ... - } - } + Returns a list of all api actions + takes { + code: boolean, // if true, return source code (optional) + docs: boolean // if true, return doc strings (optional) + } + returns { + actions: { + name: { + cache: boolean, // if false, don't cache results + code: string, // source code + doc: string // doc strings + }, + ... // more actions } + } ''' docs = data.get('docs', False) code = data.get('code', False)