You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@wookie.apache.org by sc...@apache.org on 2012/03/23 13:12:11 UTC

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

Author: scottbw
Date: Fri Mar 23 12:12:11 2012
New Revision: 1304299

URL: http://svn.apache.org/viewvc?rev=1304299&view=rev
Log:
More API examples

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=1304299&r1=1304298&r2=1304299&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:12:11 2012
@@ -160,6 +160,8 @@ Participants are represented in XML as a
 
 For example:
 
+*GET http://localhost:8080/wookie/participants?id_key=j5GGdhIQViNCRTWg5wnSrccDaks.eq.&api_key=TEST*
+
     <participants>
       <participant id="testuser" display_name="First Test User" thumbnail_url=""/>
       <participant id="testuser2" display_name="Second Test User" thumbnail_url=""/>
@@ -201,6 +203,12 @@ The Properties API contains methods for 
 
 A property consists of a <em>propertyname</em> and <em>propertyvalue</em>.
 
+Example:
+
+GET http://localhost:8080/wookie/properties?id_key=AoK9uakcv4M.pl.jRTcgQs3x4D0jrs.eq.&api_key=TEST&propertyname=city
+
+    manchester
+
 <table border="1"><tbody>
 <tr>
 <th >Request</th>
@@ -281,6 +289,18 @@ This API is used to manage API Keys for 
 
 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.
 
+Example:
+
+GET http://localhost:8080/wookie/policies
+
+    <policies>
+    <policy scope="http://wookie.apache.org/widgets/freeder" origin="*" directive="ALLOW"/>
+    <policy scope="http://www.getwookie.org/widgets/weather" origin="http://newsrss.bbc.co.uk:80" directive="ALLOW"/>
+    <policy scope="*" origin="http://127.0.0.1" directive="ALLOW"/>
+    <policy scope="*" origin="http://localhost:8080" directive="ALLOW"/>
+    <policy scope="*" origin="http://*.apache.org" directive="ALLOW"/>
+    </policies>
+
 <TABLE border="1"><TBODY>
 <TR>
 <TH>Request</TH>