Author: scottbw
Date: Fri Mar 23 12:15:14 2012
New Revision: 1304303
URL: http://svn.apache.org/viewvc?rev=1304303&view=rev
Log:
More API doc tidying and 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=1304303&r1=1304302&r2=1304303&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:15:14 2012
@@ -34,7 +34,6 @@ Clients may request a response in either
The Widget Instances API is used to request an instance of a Widget for a
particular viewer in a particular context.
-###Instance Parameters
An instance is identified using a combination of the following parameters:
- api_key: The key issued to a particular application
@@ -43,8 +42,6 @@ An instance is identified using a combin
- widgetid: The URI of the widget this is an instance of
- locale: The preferred locale of the widget, expressed using a BCP47 Language
Tag
-###Representation
-
An instance is represented in XML as follows:
<widgetdata>
@@ -95,9 +92,7 @@ If an instance already exists for the gi
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.
-###Representation
-
-A Widget is currently represented in XML using an abbreviated form of the W3C
Widgets packaging format:
+A Widget is represented in XML using an abbreviated form of the W3C Widgets
packaging format:
<?xml version="1.0" encoding="UTF-8"?>
<widgets>
@@ -150,8 +145,6 @@ The "id" attribute is used in other API
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.
-##Representation
-
Participants are represented in XML as a <participants> document,
containing a <participant> element for each participant, with the
attributes:
- id: the participant id (not to be confused with Wookie's internal id of a
participant)
@@ -244,8 +237,6 @@ GET http://localhost:8080/wookie/propert
This API is used to manage API Keys for applications accessing Wookie.
-###Representation
-
<keys>
<key id="401" value="TEST" email="[email protected]"/>
</keys>
