0x2620/python-ox
2
1
Fork 0
Code Issues Pull requests Releases Wiki Activity

update documentation of api.api

Browse source
This commit is contained in:
rolux 2014-12-18 20:37:47 +00:00
parent 27c701b97a
commit edf876c119
1 changed files with 14 additions and 20 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
ox/django/api/actions.py
View file

@ -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)