Author: woonsan
Date: Tue Jan 5 14:21:00 2010
New Revision: 896061
URL: http://svn.apache.org/viewvc?rev=896061&view=rev
Log:
JS2-1084: Adding example responses to the documentation of Jetspeed REST API
Modified:
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml
Modified:
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml
URL:
http://svn.apache.org/viewvc/portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml?rev=896061&r1=896060&r2=896061&view=diff
==============================================================================
---
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml
(original)
+++
portals/site/jetspeed/jetspeed-2.2/jetspeed-guide-dev/src/site/xdoc/guide-rest-api.xml
Tue Jan 5 14:21:00 2010
@@ -957,6 +957,13 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"j2-admin::LoginPortlet",
+ "id":"template-top2.page-template.dashboard-1000.dashboard-1003",
+ "type":"portlet",
+ "locked":false,
+ "properties":{"row":"0","column":"2"}
+}
]]></source>
</td>
@@ -965,6 +972,22 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<fragment>
+ <id>template-top2.page-template.dashboard-1000.dashboard-1003</id>
+ <locked>false</locked>
+ <name>j2-admin::LoginPortlet</name>
+ <type>portlet</type>
+ <properties>
+ <entry>
+ <key>row</key>
+ <value>0</value>
+ </entry>
+ <entry>
+ <key>column</key>
+ <value>2</value>
+ </entry>
+ </properties>
+</fragment>
]]></source>
</td>
</tr>
@@ -1067,6 +1090,13 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"demo::PickANumberPortlet",
+ "id":"template-top2.page-template.dashboard-1000.P-125fec68f7c-10000",
+ "type":"portlet",
+ "locked":false,
+ "properties":{"row":"2","column":"2"}
+}
]]></source>
</td>
@@ -1075,6 +1105,22 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<fragment>
+ <id>template-top2.page-template.dashboard-1000.P-125fec68f7c-10000</id>
+ <locked>false</locked>
+ <name>demo::PickANumberPortlet</name>
+ <type>portlet</type>
+ <properties>
+ <entry>
+ <key>row</key>
+ <value>2</value>
+ </entry>
+ <entry>
+ <key>column</key>
+ <value>2</value>
+ </entry>
+ </properties>
+</fragment>
]]></source>
</td>
</tr>
@@ -1134,7 +1180,7 @@
<td>REST API examples</td>
<td>
<source><![CDATA[
-DELETE
http://localhost:8080/collab/services/pagelayout/fragment/template-top2.page-template.dashboard-1000.P-125fac24b80-10000/?_type=json
+DELETE
http://localhost:8080/jetspeed/services/pagelayout/fragment/template-top2.page-template.dashboard-1000.P-125fac24b80-10000/?_type=json
With the following request header:
X-Portal-Path: /default-page.psml
@@ -1145,6 +1191,13 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"demo::PickANumberPortlet",
+ "id":"template-top2.page-template.dashboard-1000.P-125fec68f7c-10000",
+ "type":"portlet",
+ "locked":false,
+ "properties":{"row":"2","column":"2"}
+}
]]></source>
</td>
@@ -1153,6 +1206,22 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<fragment>
+ <id>template-top2.page-template.dashboard-1000.P-125fec68f7c-10000</id>
+ <locked>false</locked>
+ <name>demo::PickANumberPortlet</name>
+ <type>portlet</type>
+ <properties>
+ <entry>
+ <key>row</key>
+ <value>2</value>
+ </entry>
+ <entry>
+ <key>column</key>
+ <value>2</value>
+ </entry>
+ </properties>
+</fragment>
]]></source>
</td>
</tr>
@@ -1302,6 +1371,13 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"j2-admin::LocaleSelector",
+ "id":"template-top2.page-template.dashboard-1000.dashboard-1007",
+ "type":"portlet",
+ "locked":false,
+ "properties":{"row":"1","column":"2"}
+}
]]></source>
</td>
@@ -1310,6 +1386,22 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<fragment>
+ <id>template-top2.page-template.dashboard-1000.dashboard-1007</id>
+ <locked>false</locked>
+ <name>j2-admin::LocaleSelector</name>
+ <type>portlet</type>
+ <properties>
+ <entry>
+ <key>row</key>
+ <value>1</value>
+ </entry>
+ <entry>
+ <key>column</key>
+ <value>2</value>
+ </entry>
+ </properties>
+</fragment>
]]></source>
</td>
</tr>
@@ -1371,7 +1463,7 @@
<td>mode</td>
<td>Yes</td>
<td></td>
- <td>view</td>
+ <td>View</td>
<td>The portlet mode of the content fragment.</td>
</tr>
<tr>
@@ -1379,7 +1471,7 @@
<td>state</td>
<td>Yes</td>
<td></td>
- <td>normal</td>
+ <td>Normal</td>
<td>The window state of the content fragment.</td>
</tr>
</table>
@@ -1389,7 +1481,7 @@
<td>REST API examples</td>
<td>
<source><![CDATA[
-PUT
http://localhost:8080/jetspeed/services/pagelayout/fragment/template-top2.page-template.dashboard-1000.dashboard-1007/mode/?_type=json&mode=view&state=normal
+PUT
http://localhost:8080/jetspeed/services/pagelayout/fragment/template-top2.page-template.dashboard-1000.dashboard-1007/mode/?_type=json&mode=View&state=Normal
With the following request header:
X-Portal-Path: /default-page.psml
@@ -1400,6 +1492,15 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"j2-admin::LocaleSelector",
+ "id":"template-top2.page-template.dashboard-1000.dashboard-1007",
+ "type":"portlet",
+ "mode":"View",
+ "state":"Normal",
+ "locked":false,
+ "properties":{"row":"1","column":"2"}
+}
]]></source>
</td>
@@ -1408,6 +1509,24 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<fragment>
+ <id>template-top2.page-template.dashboard-1000.dashboard-1007</id>
+ <locked>false</locked>
+ <name>j2-admin::LocaleSelector</name>
+ <type>portlet</type>
+ <mode>View</mode>
+ <state>Normal</state>
+ <properties>
+ <entry>
+ <key>row</key>
+ <value>1</value>
+ </entry>
+ <entry>
+ <key>column</key>
+ <value>2</value>
+ </entry>
+ </properties>
+</fragment>
]]></source>
</td>
</tr>
@@ -1478,6 +1597,39 @@
<td>JSON Response Example</td>
<td>
<source><![CDATA[
+{
+ "name":"jetspeed",
+ "basePath":"/decorations/portlet/jetspeed",
+ "actionsOption":"SHOW",
+ "styleSheet":"decorations/portlet/jetspeed/css/styles.css",
+ "baseCSSClass":"jetspeed",
+ "decoratorActions":[
+ {
+ "name":"Configure",
+ "link":"decorations/portlet/jetspeed/images/config.gif",
+
"action":"http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xjNA__/";,
+ "actionType":"mode",
+ "actionName":"config",
+ "alt":"Configure"
+ },
+ {
+ "name":"Minimize",
+ "link":"decorations/portlet/jetspeed/images/minimized.gif",
+
"action":"http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xkMQ__/";,
+ "actionType":"state",
+ "actionName":"minimized",
+ "alt":"Minimize"
+ },
+ {
+ "name":"Maximize",
+ "link":"decorations/portlet/jetspeed/images/maximized.gif",
+
"action":"http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xkMg__/";,
+ "actionType":"state",
+ "actionName":"maximized",
+ "alt":"Maximize"
+ }
+ ]
+}
]]></source>
</td>
@@ -1486,6 +1638,39 @@
<td>XML Response Example</td>
<td>
<source><![CDATA[
+<decoration>
+ <name>jetspeed</name>
+ <actionsOption>SHOW</actionsOption>
+ <baseCSSClass>jetspeed</baseCSSClass>
+ <basePath>/decorations/portlet/jetspeed</basePath>
+ <styleSheet>decorations/portlet/jetspeed/css/styles.css</styleSheet>
+ <decoratorActions>
+ <decoratorAction>
+
<action>http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xjNA__/</action>
+ <actionName>config</actionName>
+ <actionType>mode</actionType>
+ <alt>Configure</alt>
+ <link>decorations/portlet/jetspeed/images/config.gif</link>
+ <name>Configure</name>
+ </decoratorAction>
+ <decoratorAction>
+
<action>http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xkMQ__/</action>
+ <actionName>minimized</actionName>
+ <actionType>state</actionType>
+ <alt>Minimize</alt>
+ <link>decorations/portlet/jetspeed/images/minimized.gif</link>
+ <name>Minimize</name>
+ </decoratorAction>
+ <decoratorAction>
+
<action>http://localhost:8080/jetspeed/services/_ns:YXRlbXBsYXRlLXRvcDIucGFnZS10ZW1wbGF0ZS5kYXNoYm9hcmQtMTAwMC5kYXNoYm9hcmQtMTAwM3xkMg__/</action>
+ <actionName>maximized</actionName>
+ <actionType>state</actionType>
+ <alt>Maximize</alt>
+ <link>decorations/portlet/jetspeed/images/maximized.gif</link>
+ <name>Maximize</name>
+ </decoratorAction>
+ </decoratorActions>
+</decoration>
]]></source>
</td>
</tr>
