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:15:18 UTC
svn commit: r809711 - in /websites/staging/wookie/trunk/content: ./
wookie/docs/api.html
Author: buildbot
Date: Fri Mar 23 12:15:17 2012
New Revision: 809711
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:15:17 2012
@@ -1 +1 @@
-1304299
+1304303
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:15:17 2012
@@ -89,7 +89,6 @@
<p><em>Note that as of Wookie 0.10.0 not all APIs have yet been updated to supply JSON responses.</em></p>
<h1 id="widget-instances">Widget Instances</h1>
<p>The Widget Instances API is used to request an instance of a Widget for a particular viewer in a particular context.</p>
-<h3 id="instance-parameters">Instance Parameters</h3>
<p>An instance is identified using a combination of the following parameters:</p>
<ul>
<li>api_key: The key issued to a particular application</li>
@@ -98,7 +97,6 @@
<li>widgetid: The URI of the widget this is an instance of</li>
<li>locale: The preferred locale of the widget, expressed using a BCP47 Language Tag</li>
</ul>
-<h3 id="representation">Representation</h3>
<p>An instance is represented in XML as follows:</p>
<div class="codehilite"><pre> <span class="nt"><widgetdata></span>
<span class="nt"><url></span>URL TO ACCESS WIDGET<span class="nt"></url></span>
@@ -148,8 +146,7 @@ If an instance already exists for the gi
<h1 id="widgets">Widgets</h1>
<p>The Widgets API is used to get the list of available widgets, information about a specific widget. For administrators, this API is also used to manage widgets, including installing, updating and deleting.</p>
-<h3 id="representation_1">Representation</h3>
-<p>A Widget is currently represented in XML using an abbreviated form of the W3C Widgets packaging format:</p>
+<p>A Widget is represented in XML using an abbreviated form of the W3C Widgets packaging format:</p>
<div class="codehilite"><pre><span class="cp"><?xml version="1.0" encoding="UTF-8"?></span>
<span class="nt"><widgets></span>
<span class="nt"><widget</span> <span class="na">id=</span><span class="s">"http://wookie.apache.org/widgets/geo"</span> <span class="na">width=</span><span class="s">"620"</span> <span class="na">height=</span><span class="s">"660"</span> <span class="na">version=</span><span class="s">"0.1"</span><span class="nt">></span>
@@ -200,7 +197,6 @@ If an instance already exists for the gi
<h1 id="participants">Participants</h1>
<p>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.</p>
-<h2 id="representation_2">Representation</h2>
<p>Participants are represented in XML as a <participants> document, containing a <participant> element for each participant, with the attributes:</p>
<ul>
<li>id: the participant id (not to be confused with Wookie's internal id of a participant)</li>
@@ -283,7 +279,6 @@ If an instance already exists for the gi
<h2 id="api-keys_1">API Keys</h2>
<p>This API is used to manage API Keys for applications accessing Wookie.</p>
-<h3 id="representation_3">Representation</h3>
<div class="codehilite"><pre><span class="nt"><keys></span>
<span class="nt"><key</span> <span class="na">id=</span><span class="s">"401"</span> <span class="na">value=</span><span class="s">"TEST"</span> <span class="na">email=</span><span class="s">"test@127.0.0.1"</span><span class="nt">/></span>
<span class="nt"></keys></span>