Author: moon
Date: Sun Dec 27 19:40:21 2015
New Revision: 1721836
URL: http://svn.apache.org/viewvc?rev=1721836&view=rev
Log:
https://github.com/apache/incubator-zeppelin/pull/550
Modified:
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml?rev=1721836&r1=1721835&r2=1721836&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/atom.xml Sun Dec 27
19:40:21 2015
@@ -4,7 +4,7 @@
<title>Apache Zeppelin (incubating)</title>
<link href="http://zeppelin.incubator.apache.org/"; rel="self"/>
<link href="http://zeppelin.incubator.apache.org"/>
- <updated>2015-12-22T21:05:25+09:00</updated>
+ <updated>2015-12-27T11:31:15-08:00</updated>
<id>http://zeppelin.incubator.apache.org</id>
<author>
<name>The Apache Software Foundation</name>
Modified:
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html?rev=1721836&r1=1721835&r2=1721836&view=diff
==============================================================================
---
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html
(original)
+++
incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html
Sun Dec 27 19:40:21 2015
@@ -512,7 +512,7 @@ limitations under the License.
</tr>
<tr>
<td> sample JSON response </td>
-
<td><pre>{"status":"OK","body":[{"id":"20151121-212654<em>766735423","status":"FINISHED","finished":"Tue
Nov 24 14:21:40 KST 2015","started":"Tue Nov 24 14:21:39
KST
2015"},{"id":"20151121-212657</em>730976687","status":"FINISHED","finished":"Tue
Nov 24 14:21:40 KST 2015","started":"Tue Nov 24 14:21:40
KST 2015"}]}</pre></td>
+
<td><pre>{"status":"OK","body":[{"id":"20151121-212654<em>766735423","status":"FINISHED","finished":"Tue
Nov 24 14:21:40 KST 2015","started":"Tue Nov 24 14:21:39
KST
2015"},{"progress":"1","id":"20151121-212657</em>730976687","status":"RUNNING","finished":"Tue
Nov 24 14:21:35 KST 2015","started":"Tue Nov 24 14:21:40
KST 2015"}]}</pre></td>
</tr>
</table></p>
@@ -688,6 +688,220 @@ limitations under the License.
</tr>
</table></p>
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Full-text search through the paragraphs in all notebooks</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td><code>GET</code> request will return list of matching paragraphs
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/search?q=[query]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td>Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td>Sample JSON response </td>
+ <td><pre>{"status":"OK", body:
[{"id":"<noteId>/paragraph/<paragraphId>",
"name":"Notebook Name", "snippet":"",
"text":""}]}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Create paragraph</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method create a new paragraph using JSON
payload.
+ The body field of the returned JSON contain the new paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input (add to the last) </td>
+ <td><pre>
+ {
+ "title": "Paragraph insert revised",
+ "text": "%spark\nprintln(\"Paragraph insert
revised\")"
+ }</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON input (add to specific index) </td>
+ <td><pre>
+ {
+ "title": "Paragraph insert revised",
+ "text": "%spark\nprintln(\"Paragraph insert
revised\")",
+ "index": 0
+ }
+ </pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "CREATED","message":
"","body":
"20151218-100330_1754029574"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Get paragraph</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method retrieves an existing paragraph's
information using the given id.
+ The body field of the returned JSON contain information about
paragraph.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "title": "Paragraph2",
+ "text": "%spark\n\nprintln(\"it's
paragraph2\")",
+ "dateUpdated": "Dec 18, 2015 7:33:54 AM",
+ "config": {
+ "colWidth": 12,
+ "graph": {
+ "mode": "table",
+ "height": 300,
+ "optionOpen": false,
+ "keys": [],
+ "values": [],
+ "groups": [],
+ "scatter": {}
+ },
+ "enabled": true,
+ "title": true,
+ "editorMode": "ace/mode/scala"
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName":
"paragraph<em>1450391574392</em>-1890856722",
+ "id": "20151218-073254_1105602047",
+ "result": {
+ "code": "SUCCESS",
+ "type": "TEXT",
+ "msg": "it's paragraph2\n"
+ },
+ "dateCreated": "Dec 18, 2015 7:32:54 AM",
+ "dateStarted": "Dec 18, 2015 7:33:55 AM",
+ "dateFinished": "Dec 18, 2015 7:33:55 AM",
+ "status": "FINISHED",
+ "progressUpdateIntervalMs": 500
+ }
+}
+ </pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Move paragraph</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method moves a paragraph to the specific
index (order) from the notebook.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]/move/[newIndex]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+
<td><pre>{"status":"OK","message":""}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Delete paragraph</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes a paragraph by the given
notebook and paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]/paragraph/[paragraphId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>200</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+
<td><pre>{"status":"OK","message":""}</pre></td>
+ </tr>
+ </table></p>
+
</div>
</div>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml
URL:
http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml?rev=1721836&r1=1721835&r2=1721836&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rss.xml Sun Dec 27
19:40:21 2015
@@ -5,8 +5,8 @@
<description>Apache Zeppelin (incubating) - The Apache Software
Foundation</description>
<link>http://zeppelin.incubator.apache.org</link>
<link>http://zeppelin.incubator.apache.org</link>
- <lastBuildDate>2015-12-22T21:05:25+09:00</lastBuildDate>
- <pubDate>2015-12-22T21:05:25+09:00</pubDate>
+ <lastBuildDate>2015-12-27T11:31:15-08:00</lastBuildDate>
+ <pubDate>2015-12-27T11:31:15-08:00</pubDate>
<ttl>1800</ttl>
