Skip to content

Add in docs for getAuthorName API method #982

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
JohnMcLear merged 1 commit into from
Sep 6, 2012
Merged

Add in docs for getAuthorName API method #982

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion doc/api/http_api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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}`

### 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:*
* `{code: 0, message:"ok", data: {authorID: "a.s8oes9dhwrvt0zif"}}`
Expand All @@ -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: 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

### Session
Expand Down