svn commit: r791806 - /websites/staging/esme/trunk/content/docs/apis/api-2.0---design.html

[bu...@apache.org]

Author: buildbot
Date: Wed Jun 29 06:50:45 2011
New Revision: 791806

Log:
Staging update by buildbot

Modified:
    websites/staging/esme/trunk/content/docs/apis/api-2.0---design.html

Modified: websites/staging/esme/trunk/content/docs/apis/api-2.0---design.html
==============================================================================
--- websites/staging/esme/trunk/content/docs/apis/api-2.0---design.html (original)
+++ websites/staging/esme/trunk/content/docs/apis/api-2.0---design.html Wed Jun 29 06:50:45 2011
@@ -54,37 +54,7 @@
 
   <div id="content">
     <h1 class="title">API 2.0 - Design</h1>
-    <p>{float:right|width=40%}
-{panel:title=Contents}
-   * <a href="#API2.0-Design-Streamsvs.Resources">Streams vs. Resources</a>
-   * <a href="#API2.0-Design-Resource/Object/StreamHierarchy">Resource/Object/Stream Hierarchy</a>
-   * <a href="#API2.0-Design-Methods,Resources,andDescriptions">Methods, Resources, and Descriptions</a>
-   * <a href="#API2.0-Design-" />
-   * <a href="#API2.0-Design-Streams">Streams</a>
-      * <a href="#API2.0-Design-Authorizationandroles">Authorization and roles</a>
-      * <a href="#API2.0-Design-ESMEHTTPComet/long-pollingimplementationforstreams">ESME HTTP Comet/long-polling implementation for streams</a>
-      * <a href="#API2.0-Design-Streams/Message-queuesinESMEandingeneral">Streams/Message-queues in ESME and in general</a>
-   * <a href="#API2.0-Design-Formats">Formats</a>
-      * <a href="#API2.0-Design-Requestformats">Request formats</a>
-      * <a href="#API2.0-Design-Responseformats">Response formats</a>
-   * <a href="#API2.0-Design-Authorization">Authorization</a>
-   * <a href="#API2.0-Design-Clients">Clients</a>
-{panel}</p>
-<p>{panel:title=Points for discussion, resolution, further work}
-1. Is the use of HTTP sessions necessary? Is it desirable?
-1. Request signing methods?
-1. Payload and response schemas must be defined
-1. Should API contain admin functions?
-1. Webhooks (<a href="http://blog.webhooks.org/">http://blog.webhooks.org/</a>
-)
-1. * ESME has webhooks as part of its actions framework, but we may want to document their existence as part of the API, and possibly improve the functionality if there are use cases (<a href="http://incubator.apache.org/esme/actions.html">http://incubator.apache.org/esme/actions.html</a>
-)
-1. What is a conversation?
-1. Authorization approach (see above)
-1. What is our streaming approach?
-{panel}
-{float}</p>
-<p><a name="API2.0-Design-Streamsvs.Resources"></a></p>
+    <p><a name="API2.0-Design-Streamsvs.Resources"></a></p>
 <h2 id="streams_vs_resources">Streams vs. Resources</h2>
 <p>In the design below, all parts of ESME are modeled as resources, in keeping
 with a RESTful approach. Our streaming resources (also thought of as
@@ -174,15 +144,13 @@ to resource verbs, is worth using these 
 defining the simulation method for the entire API separately.</p>
 <p><a name="API2.0-Design-"></a></p>
 <h2 id="" />
-<p>{panel}
-<em>Note on the call:&nbsp;</em><a href="http://esmecloudserverapache.dickhirsch.staxapps.net/api2/user/messages?via=SAPRiver&amp;tag=bob&amp;message=User+&apos;">api2/user/messages</a></p>
+<p><em>Note on the call:&nbsp;</em><a href="http://esmecloudserverapache.dickhirsch.staxapps.net/api2/user/messages?via=SAPRiver&amp;tag=bob&amp;message=User+&apos;">api2/user/messages</a></p>
 <p>That call uses "tag", not "tags". Looking at the API2 code, the parameter
 name needs to be "tags".&nbsp;</p>
 <p>When it does work, I think the behavior may be a bit misleading, as tags
 added using the tags parameter do not necessarily show up in the message at
 all. So make sure to keep an eye on the tag cloud or go to the page for the
-specific tag you are trying to add and see if it shows up there.
-{panel}</p>
+specific tag you are trying to add and see if it shows up there.</p>
 <p><a name="API2.0-Design-Streams"></a></p>
 <h2 id="streams">Streams</h2>
 <p>There are a lot of ways we can model streams and I'm very interested in