Author: moon
Date: Mon Dec 21 19:31:01 2015
New Revision: 1721240
URL: http://svn.apache.org/viewvc?rev=1721240&view=rev
Log:
https://issues.apache.org/jira/browse/ZEPPELIN-507
https://issues.apache.org/jira/browse/ZEPPELIN-509
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=1721240&r1=1721239&r2=1721240&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 Mon Dec 21
19:31:01 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-21T11:31:58+09:00</updated>
+ <updated>2015-12-22T04:31:59+09: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=1721240&r1=1721239&r2=1721240&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
Mon Dec 21 19:31:01 2015
@@ -163,7 +163,7 @@ limitations under the License.
<h3>Notebook REST API list</h3>
-<p>Notebooks REST API supports the following operations: List, Create, Delete
& Clone as detailed in the following table </p>
+<p>Notebooks REST API supports the following operations: List, Create, Get,
Delete, Clone, Run as detailed in the following table </p>
<p><table class="table-configuration">
<col width="200">
@@ -254,6 +254,108 @@ limitations under the License.
<p><table class="table-configuration">
<col width="200">
<tr>
+ <th>Get notebook</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method retrieves an existing notebook's
information using the given id.
+ The body field of the returned JSON contain information about
paragraphs in the notebook.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[notebookId]</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": {
+ "paragraphs": [
+ {
+ "text": "%sql \nselect age, count(1) value\nfrom bank
\nwhere age < 30 \ngroup by age \norder by age",
+ "config": {
+ "colWidth": 4,
+ "graph": {
+ "mode": "multiBarChart",
+ "height": 300,
+ "optionOpen": false,
+ "keys": [
+ {
+ "name": "age",
+ "index": 0,
+ "aggr": "sum"
+ }
+ ],
+ "values": [
+ {
+ "name": "value",
+ "index": 1,
+ "aggr": "sum"
+ }
+ ],
+ "groups": [],
+ "scatter": {
+ "xAxis": {
+ "name": "age",
+ "index": 0,
+ "aggr": "sum"
+ },
+ "yAxis": {
+ "name": "value",
+ "index": 1,
+ "aggr": "sum"
+ }
+ }
+ }
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName":
"paragraph<em>1423500782552</em>-1439281894",
+ "id": "20150210-015302_1492795503",
+ "result": {
+ "code": "SUCCESS",
+ "type": "TABLE",
+ "msg":
"age\tvalue\n19\t4\n20\t3\n21\t7\n22\t9\n23\t20\n24\t24\n25\t44\n26\t77\n27\t94\n28\t103\n29\t97\n"
+ },
+ "dateCreated": "Feb 10, 2015 1:53:02 AM",
+ "dateStarted": "Jul 3, 2015 1:43:17 PM",
+ "dateFinished": "Jul 3, 2015 1:43:23 PM",
+ "status": "FINISHED",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "Zeppelin Tutorial",
+ "id": "2A94M5J1Z",
+ "angularObjects": {},
+ "config": {
+ "looknfeel": "default"
+ },
+ "info": {}
+ }
+}
+ </pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
<th>Delete notebook</th>
<th></th>
</tr>
@@ -439,6 +541,18 @@ limitations under the License.
<td> 500 </td>
</tr>
<tr>
+ <td> sample JSON input (optional, only needed when if you want to update
dynamic form's value) </td>
+ <td><pre>
+{
+ "name": "name of new notebook",
+ "params": {
+ "formLabel1": "value1",
+ "formLabel2": "value2"
+ }
+}
+ </pre></td>
+ </tr>
+ <tr>
<td> sample JSON response </td>
<td><pre>{"status":"OK"}</pre></td>
</tr>
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=1721240&r1=1721239&r2=1721240&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 Mon Dec 21
19:31:01 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-21T11:31:58+09:00</lastBuildDate>
- <pubDate>2015-12-21T11:31:58+09:00</pubDate>
+ <lastBuildDate>2015-12-22T04:31:59+09:00</lastBuildDate>
+ <pubDate>2015-12-22T04:31:59+09:00</pubDate>
<ttl>1800</ttl>
