Author: scottbw
Date: Fri Mar 23 11:33:25 2012
New Revision: 1304284
URL: http://svn.apache.org/viewvc?rev=1304284&view=rev
Log:
Removed legacy and 0.9.x specific information - moved to new link
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=1304284&r1=1304283&r2=1304284&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:33:25 2012
@@ -16,12 +16,14 @@ Notice: Licensed to the Apache Softwa
specific language governing permissions and limitations
under the License.
+For the API for earlier versions of Wookie, see the [0.9.x API Reference][1].
+
# API key
Note that except where noted, all methods require the requesting application
to have a valid API key issued by the Wookie server administrator.
-# Widget Instances (from 0.9.0)
+# Widget Instances
An instance is identified using a combination of the following parameters:
- api_key: The key issued to a particular application
@@ -79,7 +81,7 @@ If an instance already exists for the gi
</tr>
</table>
-# Widgets (from 0.9.0)
+# Widgets
##Representation
@@ -87,16 +89,15 @@ A Widget is currently represented in XML
<?xml version="1.0" encoding="UTF-8"?>
<widgets>
- <widget id="7" identifier="http://wookie.apache.org/widgets/geo";
width="620" height="660" version="0.1">
- <title short="">geo</title>
+ <widget id="http://wookie.apache.org/widgets/geo"; width="620"
height="660" version="0.1">
+ <name short="">geo</title>
<description>An example of a HTML 5 geolocation
widget.</description>
-
<icon>http://localhost:8080/wookie/wservices/wookie.apache.org/widgets/geo/icon.svg</icon>
+ <icon
src="http://localhost:8080/wookie/wservices/wookie.apache.org/widgets/geo/icon.svg"/>
<author>Apache Wookie (Incubating) Team</author>
</widget>
</widgets>
-**Note** the "id" attribute is a Wookie-specific identifier that should be
used as the URL parameter for REST API methods; in the above example, requests
relating to this widget would
-be addressed to /widgets/7. The "identifier" attribute corresponds to the W3C
WIdgets "identifier" attribute, and contains the URI of the Widget,
+The "id" attribute is used in other API requests.
<table border="1"><tbody>
<tr>
@@ -104,28 +105,30 @@ be addressed to /widgets/7. The "identif
<th >Description</th>
</tr>
<tr>
-<td > GET {wookie}/widgets{?all=true, locale=<em>language_tag</em>} </td>
+<td > GET {wookie}/widgets{?locale=<em>language_tag</em>} </td>
<td > Returns an XML representation of the set of available widgets. Note that
this does not require an API key.
If a locale is specified, the returned information is localized, for example
widget titles, descriptions, license information will be in the specified
language where available.
-
-(Note: For versions before 0.10.0, if the "all=true" parameter is omitted, the
list only contains the default widgets for defined service types. This
parameter is ignored from 0.10.0 onwards)
</td>
</tr>
<tr>
-<td > GET {wookie}/widgets/{service_name} {?locale=<em>language_tag</em>} </td>
-<td > Deprecated: Removed from 0.10 onwards </td>
-</tr>
-<tr>
<td > GET {wookie}/widgets/{id} {?locale=<em>language_tag</em>}</td>
<td > Returns an XML representation of the widget with the specified
<em>id</em>. Note that in the current release this is the actual database key;
future releases should implement this using the widget URI as the <em>id</em>.
If a locale is specified, the returned information is localized, for example
widget titles, descriptions, license information will be in the specified
language where available.</td>
</tr>
<tr>
<TD> POST {wookie}/widgets {file} </TD>
-<TD> Posts a widget file to the server; this is identical in behaviour to
dropping a ".wgt" file into the Wookie deploy folder. This method
requires authentication using a widgetadmin role, e.g. using HTTP Basic
authentication</TD>
+<TD> Adds a widget to the server. This method requires authentication using a
widgetadmin role, e.g. using HTTP Basic authentication</TD>
+</tr>
+<tr>
+<TD> PUT {wookie}/widgets/{id} {file} </TD>
+<TD> Updates the specified widget on the server. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication</TD>
+</tr>
+<tr>
+<TD> DELETE {wookie}/widgets/{id} </TD>
+<TD> Deletes the specified widget on the server **and any related instances
and their data**. This method requires authentication using a widgetadmin role,
e.g. using HTTP Basic authentication</TD>
</tr>
</tbody></table>
-#Participants (from 0.9.0)
+#Participants
A Participant consists of a <em>participant_display_name</em>,
<em>participant_id</em>, and <em>participant_thumbnail_url</em>. Participants
are always defined in relation to a specific Widget Instance; requests
affecting one Participant have no effect on Participants associated with other
Widget Instances.
@@ -166,7 +169,7 @@ Participants are represented in XML as a
</tbody></table>
-#Properties (from 0.9.0)
+#Properties
The Properties API contains methods for both Preferences (properties affecting
a single Widget Instance) and Shared Data (properties affecting sibling
Widgets).
@@ -200,7 +203,7 @@ A property consists of a <em>propertynam
</tbody></table>
-#Flatpack (from 0.9.1)
+#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.
@@ -236,7 +239,7 @@ By default the Admin REST API is secured
##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 (from 0.9.1)
+## API Keys
This API is used to manage API Keys for applications accessing Wookie.
@@ -272,12 +275,10 @@ This API is used to manage API Keys for
</TBODY></TABLE>
-## Policies (from 0.9.2)
+## Policies
This API is used to manage access policies for the server-side proxy. Note
that policy strings should conform to the *scope origin directive* format as
described in the `policies` file.
-*This API replaces the WARP and Whitelist APIs defined in 0.9.1.*
-
<TABLE border="1"><TBODY>
<TR>
<TH>Request</TH>
@@ -310,114 +311,6 @@ This API is used to manage access polici
</TBODY></TABLE>
-# Deprecated and Legacy APIs
-
-
-##Widget Access Request Policies (WARP) (0.9.1 only)
-
-This API is used to manage per-Widget access request policies in accordance
with the [W3C Widgets Access Request Policy][1] specification.
-
-*This API was replaced by the unified Policies API in 0.9.2*
-
-<TABLE border="1"><TBODY>
-<TR>
-<TH>Request</TH>
-<TH>Description</TH>
-</TR>
-<TR>
-
-<TD> GET {wookie}/warp {param: widgetId} </TD>
-
-<TD> Returns all access policies, or only the access policies that apply to
the widget identified by the <EM>widgetId</EM> parameter. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication</TD>
-</TR>
-<TR>
-
-<TD> GET {wookie}/warp/{id} </TD>
-
-<TD> Returns the access policy specified by <EM>id</EM>. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication</TD>
-</TR>
-<TR>
-
-<TD> POST {wookie}/warp/ {param:widgetId, origin, subdomains} </TD>
-
-<TD> Creates a new policy with the details provided. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
-</TR>
-<TR>
-
-<TD> PUT {wookie}/warp/{id} {param: granted} </TD>
-
-<TD> Updates the policy specified by <EM>id</EM> with the status of
<EM>granted</EM> if the <EM>granted</EM> parameter is set to "true",
otherwise sets the status of the policy to <EM>not granted</EM>. This method
requires authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
-</TR>
-<TR>
-
-<TD> DELETE {wookie}/warp/{id} </TD>
-
-<TD> Deletes the policy specified by <EM>id</EM>. This method requires
authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
-</TR>
-</TBODY></TABLE>
-
-##Whitelist (0.9.1 only)
-
-This API is used to manage whitelist entries, which determine global access
rules for the Wookie server-side proxy.
-
-*This API was replaced by the unified Policies API in 0.9.2*
-
-<TABLE border="1"><TBODY>
-<TR>
-<TH>Request</TH>
-<TH>Description</TH>
-</TR>
-<TR>
-
-<TD> GET {wookie}/whitelist</TD>
-
-<TD> Returns all whitelist entries, consisting of an identifier and a URL.
This method requires authentication using a widgetadmin role, e.g. using HTTP
Basic authentication</TD>
-</TR>
-<TR>
-
-<TD> POST {wookie}/whitelist/ {param:url} </TD>
-
-<TD> Creates a new whitelist entry with the URL provided using the
<EM>url</EM> parameter. This method requires authentication using a widgetadmin
role, e.g. using HTTP Basic authentication.</TD>
-</TR>
-<TR>
-
-<TD> DELETE {wookie}/whitelist/{id} </TD>
-
-<TD> Deletes the whitelist entry specified by <EM>id</EM>. This method
requires authentication using a widgetadmin role, e.g. using HTTP Basic
authentication.</TD>
-</TR>
-</TBODY></TABLE>
-
-##Services (0.9.0-0.9.2)
-
-This API is used to manage services (categories) for widgets.
-
-*This API was deprecated in 0.9.1 and will be removed in 0.10
-
-<table border="1"><tbody>
-<tr>
-<th >Request</th>
-<th >Description</th>
-</tr>
-<tr>
-<td > GET {wookie}/services {?locale=<em>language_tag</em>}</td>
-<td > Returns an XML document containing all services and any widgets
associated with the service category. If a locale is specified, the returned
information is localized, for example widget titles, descriptions, license
information will be in the specified language where available.</td>
-</tr>
-<tr>
-<td > GET {wookie}/services/{service_name} {?locale=<em>language_tag</em>}</td>
-<td > Returns an XML representation of the service specified by
<em>service_name</em> and all the widgets associated with it. If a locale is
specified, the returned information is localized, for example widget titles,
descriptions, license information will be in the specified language where
available.</td>
-</tr>
-<tr>
-<td > POST {wookie}/services/ {param:name} </td>
-<td > Creates a new service with the name provided using the <em>name</em>
parameter. If there is already a service with this name, a http 409 (conflict)
error is returned. This method requires authentication using a widgetadmin
role, e.g. using HTTP Basic authentication.</td>
-</tr>
-<tr>
-<td > PUT {wookie}/services/{service_name} {param:name} </td>
-<td > Renames the service specified by <em>service_name</em> with the new name
given by the <em>name</em> parameter. This method requires authentication using
a widgetadmin role, e.g. using HTTP Basic authentication.</td>
-</tr>
-<tr>
-<td > DELETE {wookie}/services/{service_name} </td>
-<td > Deletes the service specified by <em>service_name</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
+ [1]: /wookie/docs/api_9.html
+ [2]: http://www.w3.org/TR/widgets-access/
\ No newline at end of file
![http://localhost:8080/wookie/wservices/wookie.apache.org/widgets/geo/icon.svg"/](http://localhost:8080/wookie/wservices/wookie.apache.org/widgets/geo/icon.svg"/){kind=link}