Author: scottbw
Date: Fri Jun 10 19:22:55 2011
New Revision: 1134420
URL: http://svn.apache.org/viewvc?rev=1134420&view=rev
Log:
updated API details (see WOOKIE-34)
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=1134420&r1=1134419&r2=1134420&view=diff
==============================================================================
--- incubator/wookie/site/trunk/content/wookie/docs/api.mdtext (original)
+++ incubator/wookie/site/trunk/content/wookie/docs/api.mdtext Fri Jun 10
19:22:55 2011
@@ -50,14 +50,26 @@ An instance is represented in XML as fol
</tr>
<tr>
- <td>GET {wookie}/widgetinstances</td>
+ <td>GET {wookie}/widgetinstances</td>
<td>Not supported.</td>
</tr>
<tr>
+ <td>GET {wookie}/widgetinstances/{instance id_key}</td>
+ <td>Returns the representation of a widget instance. If the widget instance
was not created using the provided api_key, then a 403 Forbidden status code
will be returned. If no widget instance is found, a 404 Not Found status code
will be returned. .</td>
+</tr>
+
+<tr>
+ <td>GET {wookie}/widgetinstances/ {params:instance_params}</td>
+ <td>Returns the representation of a widget instance. If the widget instance
was not created using the provided api_key, then a 403 Forbidden status code
will be returned. If no widget instance is found, a 404 Not Found status code
will be returned. .</td>
+</tr>
+
+<tr>
<td>POST {wookie}/widgetinstances {params:instance_params}</td>
<td>
-Either creates a new instance for the given parameters, or retrieves an
already-created instance. If a new instance is successfully created, the
response has a HTTP status code of 201; if an instance if successfully
retrieved, a status code of 200 is returned.
+Create a new widget instance using the given parameters. If a new widget
instance is succesfully created, a status code of 201 is returned along with
the widget instance represented in XML.
+
+If an instance already exists for the given parameters, this method will
return a status code of 200 along with the existing instance (this is intended
to support legacy clients). Note this is DEPRECATED behaviour, and future
versions of the API may simply return an error code.
</td>
</tr>
