public-offering
/
pad.pub0.org
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #982 from marcelklehr/doc/getAuthorName 

Add in docs for getAuthorName API method
pull/984/merge
John McLear 2012-09-06 04:02:47 -07:00
parent 3cbd59c769 eeb605334f
commit 0b072023f0
1 changed files with 4 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/api/http_api.md
View File

@ -136,7 +136,7 @@ Pads can belong to a group. The padID of grouppads is starting with a groupID li
* `{code: 1, message:"groupID does not exist", data: null}` * `{code: 1, message:"groupID does not exist", data: null}`
### Author ### Author
Theses authors are bind to the attributes the users choose (color and name). These authors are bound to the attributes the users choose (color and name).
* **createAuthor([name])** creates a new author <br><br>*Example returns:* * **createAuthor([name])** creates a new author <br><br>*Example returns:*
* `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}` * `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
@ -148,6 +148,9 @@ Theses authors are bind to the attributes the users choose (color and name).
* `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}` * `{code: 0, message:"ok", data: {padIDs: ["g.s8oes9dhwrvt0zif$test", "g.s8oejklhwrvt0zif$foo"]}}`
* `{code: 1, message:"authorID does not exist", data: null}` * `{code: 1, message:"authorID does not exist", data: null}`
* **getAuthorName(authorID)** Returns the Author Name of the author <br><br>*Example returns:*
* `{code: 0, message:"ok", data: {authorName: "John McLear"}}`
-> can't be deleted cause this would involve scanning all the pads where this author was -> can't be deleted cause this would involve scanning all the pads where this author was
### Session ### Session