Author: jeff.yuchang
Date: 2011-03-31 23:48:04 -0400 (Thu, 31 Mar 2011)
New Revision: 1346
Added:
trunk/docs/docbook/userguide/src/main/en-US/module/riftsaw_restful_service.xml
Modified:
trunk/docs/docbook/userguide/pom.xml
trunk/docs/docbook/userguide/src/main/en-US/master.xml
Log:
*RIFTSAW-364, added a chapter for the riftsaw restful services. (This chapter is generated
from bpel-console project)
Modified: trunk/docs/docbook/userguide/pom.xml
===================================================================
--- trunk/docs/docbook/userguide/pom.xml 2011-03-31 14:35:11 UTC (rev 1345)
+++ trunk/docs/docbook/userguide/pom.xml 2011-04-01 03:48:04 UTC (rev 1346)
@@ -16,10 +16,42 @@
<artifactId>docs</artifactId>
<version>2.3.0-SNAPSHOT</version>
</parent>
-
-
+
+ <dependencies>
+ <dependency>
+ <groupId>org.jboss.bpm</groupId>
+ <artifactId>gwt-console-server</artifactId>
+ <classifier>docs</classifier>
+ <version>${bpel.console.version}</version>
+ </dependency>
+ </dependencies>
+
<build>
<plugins>
+ <plugin>
+ <artifactId>maven-dependency-plugin</artifactId>
+ <executions>
+ <execution>
+ <id>copy-bpel-console-docs</id>
+ <phase>generate-sources</phase>
+ <goals>
+ <goal>unpack</goal>
+ </goals>
+ <configuration>
+ <artifactItems>
+ <artifactItem>
+ <groupId>org.jboss.bpm</groupId>
+ <artifactId>gwt-console-server</artifactId>
+ <classifier>docs</classifier>
+
<outputDirectory>${project.basedir}/src/main/en-US/module</outputDirectory>
+ <overWrite>true</overWrite>
+ <includes>riftsaw_restful_service.xml</includes>
+ </artifactItem>
+ </artifactItems>
+ </configuration>
+ </execution>
+ </executions>
+ </plugin>
<plugin>
<groupId>org.jboss.maven.plugins</groupId>
<artifactId>maven-jdocbook-plugin</artifactId>
Modified: trunk/docs/docbook/userguide/src/main/en-US/master.xml
===================================================================
--- trunk/docs/docbook/userguide/src/main/en-US/master.xml 2011-03-31 14:35:11 UTC (rev
1345)
+++ trunk/docs/docbook/userguide/src/main/en-US/master.xml 2011-04-01 03:48:04 UTC (rev
1346)
@@ -17,6 +17,7 @@
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/wsconfig.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/uddi.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/esb.xml"/>
- <xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/clustering.xml"/>
+ <xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/clustering.xml"/>
+ <xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/riftsaw_restful_service.xml"/>
<xi:include
xmlns:xi="http://www.w3.org/2001/XInclude"
href="module/db.xml"/>
</book>
Added: trunk/docs/docbook/userguide/src/main/en-US/module/riftsaw_restful_service.xml
===================================================================
--- trunk/docs/docbook/userguide/src/main/en-US/module/riftsaw_restful_service.xml
(rev 0)
+++
trunk/docs/docbook/userguide/src/main/en-US/module/riftsaw_restful_service.xml 2011-04-01
03:48:04 UTC (rev 1346)
@@ -0,0 +1,31 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
"http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
+]>
+<!-- Auto generated by machine, do not manually edit this -->
+<chapter id="restful_services">
+<title>Restful Services</title>
+<para>
+This is a list of Restful services that are used by the bpel console.
+<table>
+<thead>
+<th>Method</th><th>Path</th><th>Description</th><th>Consumes</th><th>Produces</th>
+</thead>
+<tbody>
+<tr><td colspan="5"><emphasis>Server Info(General REST server
information)</emphasis></td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/server/status</td><td></td><td>*/*</td><td>application/json</td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/server/resources/{project}</td><td></td><td>*/*</td><td>text/html</td></tr>
+<tr><td colspan="5"><emphasis>Process Management(Process
related data.)</emphasis></td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/process/definitions</td><td></td><td>*/*</td><td>application/json</td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/process/definition/{id}/instances</td><td></td><td>*/*</td><td>application/json</td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/process/instance/{id}/dataset</td><td></td><td>*/*</td><td>text/xml</td></tr>
+<tr><td>POST</td><td>/gwt-console-server/rs/process/instance/{id}/end/{result}</td><td></td><td>*/*</td><td>application/json</td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/process/definition/{id}/image</td><td></td><td>*/*</td><td>image/*</td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/process/definition/{id}/image/{instance}</td><td></td><td>*/*</td><td>image/*</td></tr>
+<tr><td colspan="5"><emphasis>Process Engine(Process runtime
state)</emphasis></td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs/engine/deployments</td><td></td><td>*/*</td><td>application/json</td></tr>
+<tr><td colspan="5"><emphasis>Process History(Process History
Service)</emphasis></td></tr>
+<tr><td>GET</td><td>/gwt-console-server/rs//history/search</td><td></td><td>*/*</td><td>applications/json</td></tr>
+</tbody>
+</table>
+</para>
+</chapter>
\ No newline at end of file