update api docs

This commit is contained in:
rolux 2014-12-19 15:31:57 +00:00
commit 3950213960
11 changed files with 69 additions and 59 deletions

View file

@ -240,11 +240,12 @@ def getEntity(request, data):
'''
Gets an entity by id
takes {
id: string,
keys: [string]
id: string, // entity id
keys: [string] // list of properties to return
}
returns {
key: value
key: value, // property id and value
... // more key/value pairs
}
see: addEntity, editEntity, findEntities, removeEntity
'''
@ -258,14 +259,12 @@ actions.register(getEntity)
@login_required_json
def removeEntity(request, data):
'''
Removes an entity
Removes one or more entities
takes {
id: string,
or
ids: [string]
}
returns {
id: string, // either entity id
ids: [string] // or list of entity ids
}
returns {}
see: addEntity, editEntity, findEntities, getEntity
'''
response = json_response()