Author: bzz
Date: Thu Dec 10 11:56:45 2015
New Revision: 1719071
URL: http://svn.apache.org/viewvc?rev=1719071&view=rev
Log:
Docs for 0.6.0 - REST notebook API
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=1719071&r1=1719070&r2=1719071&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 Thu Dec 10
11:56:45 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-10T20:44:30+09:00</updated>
+ <updated>2015-12-10T20:55:57+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=1719071&r1=1719070&r2=1719071&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
Thu Dec 10 11:56:45 2015
@@ -298,6 +298,262 @@ limitations under the License.
</tr>
</table></p>
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Run notebook job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method run all paragraph in the given
notebook id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[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"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Stop notebook job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method stop all paragraph in the given
notebook id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[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"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Get notebook job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method get all paragraph status by the given
notebook id.
+ The body field of the returned JSON contains of the array that
compose of the paragraph id, paragraph status, paragraph finish date, paragraph
started date.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[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","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>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Run paragraph job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method run the paragraph by given notebook
and paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]/[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"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Stop paragraph job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method stop the paragraph by given notebook
and paragraph id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[notebookId]/[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"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Add cron job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method add cron job by the given notebook id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[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 input </td>
+ <td><pre>{"cron": "cron expression of
notebook"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status":"OK"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Remove cron job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method remove cron job by the given
notebook id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[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"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Get clone job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method get cron job expression of given
notebook id.
+ The body field of the returned JSON contain the cron expression.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+
<td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[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","body":"* * *
* * ?"}</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=1719071&r1=1719070&r2=1719071&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 Thu Dec 10
11:56:45 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-10T20:44:30+09:00</lastBuildDate>
- <pubDate>2015-12-10T20:44:30+09:00</pubDate>
+ <lastBuildDate>2015-12-10T20:55:57+09:00</lastBuildDate>
+ <pubDate>2015-12-10T20:55:57+09:00</pubDate>
<ttl>1800</ttl>
