update documentation of api.api
This commit is contained in:
parent
27c701b97a
commit
edf876c119
1 changed files with 14 additions and 20 deletions
|
@ -55,25 +55,19 @@ class ApiActions(dict):
|
|||
|
||||
def api(request, data):
|
||||
'''
|
||||
returns list of all known api actions
|
||||
param data {
|
||||
docs: bool
|
||||
Returns a list of all api actions
|
||||
takes {
|
||||
code: boolean, // if true, return source code (optional)
|
||||
docs: boolean // if true, return doc strings (optional)
|
||||
}
|
||||
if docs is true, action properties contain docstrings
|
||||
return {
|
||||
status: {'code': int, 'text': string},
|
||||
data: {
|
||||
returns {
|
||||
actions: {
|
||||
'api': {
|
||||
cache: true,
|
||||
doc: 'recursion'
|
||||
name: {
|
||||
cache: boolean, // if false, don't cache results
|
||||
code: string, // source code
|
||||
doc: string // doc strings
|
||||
},
|
||||
'hello': {
|
||||
cache: true,
|
||||
..
|
||||
}
|
||||
...
|
||||
}
|
||||
... // more actions
|
||||
}
|
||||
}
|
||||
'''
|
||||
|
|
Loading…
Reference in a new issue