Author: scottbw
Date: Wed Jun 8 12:39:19 2011
New Revision: 1133373
URL: http://svn.apache.org/viewvc?rev=1133373&view=rev
Log:
Added doc for API Key management API.
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=1133373&r1=1133372&r2=1133373&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Wed Jun 8
12:39:19 2011
@@ -297,5 +297,40 @@ This API is used to manage per-Widget ac
</TR>
</TBODY></TABLE>
+##API Keys
+
+This API is used to manage API Keys for applications accessing Wookie.
+
+<TABLE border="1"><TBODY>
+<TR>
+<TH>Request</TH>
+<TH>Description</TH>
+</TR>
+<TR>
+
+<TD> GET {wookie}/keys </TD>
+
+<TD> Returns all API keys. This method requires authentication using a
widgetadmin role, e.g. using HTTP Basic authentication</TD>
+</TR>
+<TR>
+
+<TD> POST {wookie}/keys/ {param:apikey, email} </TD>
+
+<TD> Creates a new API key with the details provided. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
+</TR>
+<TR>
+
+<TD> PUT {wookie}/keys/{id} {param: apikey, email} </TD>
+
+<TD>**NOT YET IMPLEMENTED**. Updates the API Key specified by <EM>id</EM>.
This method requires authentication using a widgetadmin role, e.g. using HTTP
Basic authentication.</TD>
+</TR>
+<TR>
+
+<TD> DELETE {wookie}/keys/{id} </TD>
+
+<TD> Deletes the API key specified by <EM>id</EM>. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
+</TR>
+</TBODY></TABLE>
+
[1]: http://www.w3.org/TR/widgets-access/
\ No newline at end of file
