svn commit: r1304293 - /incubator/wookie/site/trunk/content/wookie/docs/api.mdtext

[scottbw]

Author: scottbw
Date: Fri Mar 23 12:03:59 2012
New Revision: 1304293

URL: http://svn.apache.org/viewvc?rev=1304293&view=rev
Log:
Added some more examples to API doc

Modified:
    incubator/wookie/site/trunk/content/wookie/docs/api.mdtext

Modified: incubator/wookie/site/trunk/content/wookie/docs/api.mdtext
URL: 
http://svn.apache.org/viewvc/incubator/wookie/site/trunk/content/wookie/docs/api.mdtext?rev=1304293&r1=1304292&r2=1304293&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Fri Mar 23 
12:03:59 2012
@@ -154,9 +154,16 @@ A Participant consists of a <em>particip
 
 Participants are represented in XML as a &lt;participants&gt; document, 
containing a &lt;participant&gt; element for each participant, with the 
attributes:
 
-- id: the participant id (not to be confused with Wookie's internal id of a 
participant)</li>
-- display_name: the participant display name</li>
-- thumbnail_url: the url of the thumbnail image for the participant</li>
+- id: the participant id (not to be confused with Wookie's internal id of a 
participant)
+- display_name: the participant display name
+- thumbnail_url: the url of the thumbnail image for the participant
+
+For example:
+
+    <participants>
+      <participant id="testuser" display_name="First Test User" 
thumbnail_url=""/>
+      <participant id="testuser2" display_name="Second Test User" 
thumbnail_url=""/>
+    </participants>
 
 
 <table border="1"><tbody>
@@ -229,6 +236,12 @@ A property consists of a <em>propertynam
 
 This API is used to manage API Keys for applications accessing Wookie.
 
+###Representation
+
+    <keys>
+      <key id="401" value="TEST" email="test@127.0.0.1"/>
+    </keys>
+
 <TABLE border="1"><TBODY>
 <TR>
 <TH>Request</TH>