0x2620/pandora
2
1
Fork 1
Code Issues 1.2k Pull requests Releases Wiki Activity

update api docs

Browse source
This commit is contained in:
rolux 2014-12-19 12:59:10 +00:00
commit 4a084d8405
9 changed files with 112 additions and 142 deletions
Download patch file Download diff file Expand all files Collapse all files

19
pandora/entity/views.py
View file

@ -33,9 +33,10 @@ def addEntity(request, data):
'''
Adds an entity
takes {
type: string,
name: string,
alternativeNames: [string]
type: string, // entity type, as defined in config
name: string, // name
alternativeNames: [string], // list of alternative names
... // more entity properties, as defined in config
}
returns {}
see: editEntity, findEntities, getEntity, removeEntity
@ -148,14 +149,14 @@ def editEntity(request, data):
'''
Edits an entity
takes {
id: string
name: string
description: string
item(optional): edit descriptoin per item
id: string, // entity id
name: string, // entity name
description: string, // entity description
... // more properties, as defined in config
}
returns {
id:
...
id: string // entity id
... // more entity properties
}
see: addEntity, findEntities, getEntity, removeEntity
'''