Author: woonsan
Date: Mon Mar 22 17:30:43 2010
New Revision: 926206
URL: http://svn.apache.org/viewvc?rev=926206&view=rev
Log:
JS2-1132: Updating rest api site documentation
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=926206&r1=926205&r2=926206&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
Mon Mar 22 17:30:43 2010
@@ -2401,6 +2401,229 @@ With the following request form paramete
</table>
</subsection>
+<subsection name='Update Node Info'>
+<table>
+ <tr>
+ <td>Entry path</td>
+ <td>/info/</td>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>Update node info based on the type parameter, the path parameter
and the form request parameters</td>
+ </tr>
+ <tr>
+ <td>HTTP Method</td>
+ <td>GET</td>
+ </tr>
+ <tr>
+ <td>Parameters</td>
+ <td>
+ <table>
+ <tr>
+ <th>Type</th>
+ <th>Name</th>
+ <th>Required</th>
+ <th>Default value</th>
+ <th>Example value</th>
+ <th>Description</th>
+ </tr>
+ <tr>
+ <td>PATH</td>
+ <td></td>
+ <td>Yes</td>
+ <td></td>
+ <td>
+ One of the following:
+ <br/>
+ <ul>
+ <li>/.psml</li>
+ <li>/folder</li>
+ <li>/.link</li>
+ </ul>
+ </td>
+ <td>
+ The first path parameter is for the node type:
+ <br/>
+ <ul>
+ <li>.psml : Page node</li>
+ <li>folder : Folder node</li>
+ <li>.link : Link node</li>
+ </ul>
+ </td>
+ </tr>
+ <tr>
+ <td>PATH</td>
+ <td></td>
+ <td>Yes</td>
+ <td></td>
+ <td>/default-page.psml</td>
+ <td>
+ The target node path to move
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>title</td>
+ <td>No</td>
+ <td></td>
+ <td>Welcome to Jetspeed</td>
+ <td>
+ The title of the node.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>shorttitle</td>
+ <td>No</td>
+ <td></td>
+ <td>Welcome</td>
+ <td>
+ The short title of the node.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>hidden</td>
+ <td>No</td>
+ <td></td>
+ <td>true or false</td>
+ <td>
+ The flag whether the target node is hidden or not.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>skin</td>
+ <td>No</td>
+ <td></td>
+ <td>jetspeed</td>
+ <td>
+ The skin name of the target node.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>version</td>
+ <td>No</td>
+ <td></td>
+ <td>true or false</td>
+ <td>
+ The version of the target node.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>docorder</td>
+ <td>No</td>
+ <td></td>
+ <td>default-page.psml, min.psml</td>
+ <td>
+ The document order of the target node. The target node
must be a folder node. Otherwise, this parameter will be just ignored.
+ </td>
+ </tr>
+ <tr>
+ <td>FORM</td>
+ <td>url</td>
+ <td>No</td>
+ <td></td>
+ <td>http://portals.apache.org</td>
+ <td>
+ The url of the target node. The target node must be a
link node. Otherwise, this parameter will be just ignored.
+ </td>
+ </tr>
+ </table>
+ </td>
+ </tr>
+ <tr>
+ <td>REST API examples</td>
+ <td>
+<source><![CDATA[
+POST
http://localhost:8080/jetspeed/services/pagemanagement/info/.psml/default-page.psml?_type=json
+
+With the following request form parameters:
+ title=Welcome to Jetspeed-2 Enterprise Portal
+]]></source>
+ </td>
+ </tr>
+ <tr>
+ <td>JSON Response Example</td>
+ <td>
+<source><![CDATA[
+{
+ "id":"/Examples/default-page.psml",
+ "name":"default-page.psml",
+ "type":".psml",
+ "path":"/Examples/default-page.psml",
+ "title":"Welcome to Jetspeed-2 Enterprise Portal",
+ "shortTitle":"Welcome to Jetspeed",
+ "hidden":false,
+ "url":"/Examples/default-page.psml",
+ "constraintsEnabled":true,
+ "permissionsEnabled":false,
+ "effectiveDefaultLayoutDecorator":"jetspeed",
+ "effectiveDefaultPortletDecorator":"jetspeed",
+ "dirty":false,
+ "metadata":
+ {
+ "fields":[
+ {
+ "name":"title",
+ "value":"Welcome to Jetspeed",
+ "localeString":"en"
+ },
+ {
+ "name":"title",
+ "value":"Bienvenido a Jetspeed 2",
+ "localeString":"es"
+ }
+ ]
+ }
+}
+]]></source>
+
+ </td>
+ </tr>
+ <tr>
+ <td>XML Response Example</td>
+ <td>
+<source><![CDATA[
+<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
+<page>
+ <id>/Examples/default-page.psml</id>
+ <name>default-page.psml</name>
+ <type>.psml</type>
+ <path>/Examples/default-page.psml</path>
+ <title>Welcome to Jetspeed-2 Enterprise Portal</title>
+ <shortTitle>Welcome to Jetspeed</shortTitle>
+ <hidden>false</hidden>
+ <url>/Examples/default-page.psml</url>
+ <constraintsEnabled>true</constraintsEnabled>
+ <permissionsEnabled>false</permissionsEnabled>
+ <effectiveDefaultLayoutDecorator>jetspeed</effectiveDefaultLayoutDecorator>
+ <effectiveDefaultPortletDecorator>jetspeed</effectiveDefaultPortletDecorator>
+ <dirty>false</dirty>
+ <metadata>
+ <fields>
+ <field>
+ <localeString>fr</localeString>
+ <name>title</name>
+ <value>Bienvenue a Jetspeed</value>
+ </field>
+ <field>
+ <localeString>es</localeString>
+ <name>title</name>
+ <value>Bienvenido a Jetspeed 2</value>
+ </field>
+ </fields>
+ </metadata>
+</page>
+]]></source>
+
+ </td>
+ </tr>
+</table>
+</subsection>
+
</section>
<section name='Spring Assembly'>
<p>
