You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@wookie.apache.org by bu...@apache.org on 2012/03/23 13:12:15 UTC
svn commit: r809710 - in /websites/staging/wookie/trunk/content: ./
wookie/docs/api.html
Author: buildbot
Date: Fri Mar 23 12:12:15 2012
New Revision: 809710
Log:
Staging update by buildbot for wookie
Modified:
websites/staging/wookie/trunk/content/ (props changed)
websites/staging/wookie/trunk/content/wookie/docs/api.html
Propchange: websites/staging/wookie/trunk/content/
------------------------------------------------------------------------------
--- cms:source-revision (original)
+++ cms:source-revision Fri Mar 23 12:12:15 2012
@@ -1 +1 @@
-1304293
+1304299
Modified: websites/staging/wookie/trunk/content/wookie/docs/api.html
==============================================================================
--- websites/staging/wookie/trunk/content/wookie/docs/api.html (original)
+++ websites/staging/wookie/trunk/content/wookie/docs/api.html Fri Mar 23 12:12:15 2012
@@ -208,6 +208,7 @@ If an instance already exists for the gi
<li>thumbnail_url: the url of the thumbnail image for the participant</li>
</ul>
<p>For example:</p>
+<p><em>GET http://localhost:8080/wookie/participants?id_key=j5GGdhIQViNCRTWg5wnSrccDaks.eq.&api_key=TEST</em></p>
<div class="codehilite"><pre><span class="nt"><participants></span>
<span class="nt"><participant</span> <span class="na">id=</span><span class="s">"testuser"</span> <span class="na">display_name=</span><span class="s">"First Test User"</span> <span class="na">thumbnail_url=</span><span class="s">""</span><span class="nt">/></span>
<span class="nt"><participant</span> <span class="na">id=</span><span class="s">"testuser2"</span> <span class="na">display_name=</span><span class="s">"Second Test User"</span> <span class="na">thumbnail_url=</span><span class="s">""</span><span class="nt">/></span>
@@ -246,6 +247,12 @@ If an instance already exists for the gi
<h1 id="properties">Properties</h1>
<p>The Properties API contains methods for both Preferences (properties affecting a single Widget Instance) and Shared Data (properties affecting sibling Widgets).</p>
<p>A property consists of a <em>propertyname</em> and <em>propertyvalue</em>.</p>
+<p>Example:</p>
+<p>GET http://localhost:8080/wookie/properties?id_key=AoK9uakcv4M.pl.jRTcgQs3x4D0jrs.eq.&api_key=TEST&propertyname=city</p>
+<div class="codehilite"><pre><span class="n">manchester</span>
+</pre></div>
+
+
<table border="1"><tbody>
<tr>
<th >Request</th>
@@ -312,6 +319,18 @@ If an instance already exists for the gi
</TBODY></TABLE></p>
<h2 id="policies">Policies</h2>
<p>This API is used to manage access policies for the server-side proxy. Note that policy strings should conform to the <em>scope origin directive</em> format as described in the <code>policies</code> file.</p>
+<p>Example:</p>
+<p>GET http://localhost:8080/wookie/policies</p>
+<div class="codehilite"><pre><span class="nt"><policies></span>
+<span class="nt"><policy</span> <span class="na">scope=</span><span class="s">"http://wookie.apache.org/widgets/freeder"</span> <span class="na">origin=</span><span class="s">"*"</span> <span class="na">directive=</span><span class="s">"ALLOW"</span><span class="nt">/></span>
+<span class="nt"><policy</span> <span class="na">scope=</span><span class="s">"http://www.getwookie.org/widgets/weather"</span> <span class="na">origin=</span><span class="s">"http://newsrss.bbc.co.uk:80"</span> <span class="na">directive=</span><span class="s">"ALLOW"</span><span class="nt">/></span>
+<span class="nt"><policy</span> <span class="na">scope=</span><span class="s">"*"</span> <span class="na">origin=</span><span class="s">"http://127.0.0.1"</span> <span class="na">directive=</span><span class="s">"ALLOW"</span><span class="nt">/></span>
+<span class="nt"><policy</span> <span class="na">scope=</span><span class="s">"*"</span> <span class="na">origin=</span><span class="s">"http://localhost:8080"</span> <span class="na">directive=</span><span class="s">"ALLOW"</span><span class="nt">/></span>
+<span class="nt"><policy</span> <span class="na">scope=</span><span class="s">"*"</span> <span class="na">origin=</span><span class="s">"http://*.apache.org"</span> <span class="na">directive=</span><span class="s">"ALLOW"</span><span class="nt">/></span>
+<span class="nt"></policies></span>
+</pre></div>
+
+
<p><TABLE border="1"><TBODY>
<TR>
<TH>Request</TH>