Author: scottbw
Date: Fri Mar 23 11:56:07 2012
New Revision: 1304291
URL: http://svn.apache.org/viewvc?rev=1304291&view=rev
Log:
More API reference tidying
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=1304291&r1=1304290&r2=1304291&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Fri Mar 23
11:56:07 2012
@@ -18,13 +18,17 @@ Notice: Licensed to the Apache Softwa
For the API for earlier versions of Wookie, see the [0.9.x API Reference][1].
-# Authentication
+## Authentication
### API keys
Some methods require the requesting application to have a valid API key issued
by the Wookie server administrator.
### HTTP Basic Authentication
By default the Admin REST API is secured using the Admin security restrictions
defined in web.xml. This means that typically the client needs to have
authenticated with the server using the admin user credentials.
+##Response formats
+Clients may request a response in either XML or JSON by setting the
appropriate request content type using the Accepts header. If it is not
possible to specify a content type in the request, clients may use the optional
"format" parameter to specify a content type override.
+
+*Note that as of Wookie 0.10.0 not all APIs have yet been updated to supply
JSON responses.*
# Widget Instances
@@ -162,10 +166,6 @@ Participants are represented in XML as a
<th>Authentication</th>
</tr>
<tr>
-<td >GET {wookie}/participants </td>
-<td > Not supported.</td>
-</tr>
-<tr>
<td >GET {wookie}/participants {params: <em>instance_params</em>}</td>
<td > Returns an XML representation of the Participants associated with the
Widget instance specified by {instance params}.</td>
<td>API key</td>
@@ -223,37 +223,7 @@ A property consists of a <em>propertynam
</tbody></table>
-#Flatpack
-
-The Flatpack API contains methods for exporting a Widget Instance as a new
Widget package (.wgt file) that can be downloaded by a client.
-
-This can be used, for example, for a plugin to support users exporting the
widget (including any preferences they have set) for side-loading onto a mobile
device or running in a desktop environment like Opera Widgets.
-
-**Note** this is new functionality only available in latest builds, and has a
number of limitations (for example, Widgets using features like Wave won't
export properly).
-<table border="1"><tbody>
-<tr>
-<th >Request</th>
-<th >Description</th>
- <th>Authentication</th>
-</tr>
-<tr>
-<td >GET {wookie}/flatpack/{package_id}.wgt</td>
-<td >Downloads the specified widget package.</td>
-<td>Not required</td>
-</tr>
-<tr>
-<td >POST {wookie}/flatpack {params: <em>instance_params</em></td>
-<td >creates a new W3C Widget package (.wgt) with an opaque file name for the
specified widget instance, and returns the download URL. </td>
-<td>API key</td>
-</tr>
-</tbody></table>
-
-#Administration Functions
-
-The following sections describe the API invoked by admin clients for managing
the Wookie server, e.g. for managing whitelist entries or widget access
policies.
-##Response formats
-Clients may request a response in either XML or JSON by setting the
appropriate request content type. (If it is not possible to specify a content
type in the request, clients may use the optional "format" parameter to specify
a content type override.)
## API Keys
@@ -334,7 +304,30 @@ This API is used to manage access polici
</TR>
</TBODY></TABLE>
+#Flatpack (unstable)
+The Flatpack API contains methods for exporting a Widget Instance as a new
Widget package (.wgt file) that can be downloaded by a client.
+
+This can be used, for example, for a plugin to support users exporting the
widget (including any preferences they have set) for side-loading onto a mobile
device or running in a desktop environment like Opera Widgets.
+
+**Note** this is new functionality, and has a number of limitations (for
example, Widgets using features like Wave won't export properly). For this
reason this API is flagged as unstable and may change in future releases.
+<table border="1"><tbody>
+<tr>
+<th >Request</th>
+<th >Description</th>
+ <th>Authentication</th>
+</tr>
+<tr>
+<td >GET {wookie}/flatpack/{package_id}.wgt</td>
+<td >Downloads the specified widget package.</td>
+<td>Not required</td>
+</tr>
+<tr>
+<td >POST {wookie}/flatpack {params: <em>instance_params</em></td>
+<td >creates a new W3C Widget package (.wgt) with an opaque file name for the
specified widget instance, and returns the download URL. </td>
+<td>API key</td>
+</tr>
+</tbody></table>
[1]: /wookie/docs/api_9.html
[2]: http://www.w3.org/TR/widgets-access/
\ No newline at end of file
