You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2018/11/16 20:29:57 UTC

svn commit: r1846764 - in /zeppelin/site/docs: 0.8.0/usage/rest_api/interpreter.html 0.8.0/usage/rest_api/notebook.html 0.9.0-SNAPSHOT/usage/rest_api/interpreter.html 0.9.0-SNAPSHOT/usage/rest_api/notebook.html

Author: moon
Date: Fri Nov 16 20:29:56 2018
New Revision: 1846764

URL: http://svn.apache.org/viewvc?rev=1846764&view=rev
Log:
https://github.com/apache/zeppelin/pull/3224
https://github.com/apache/zeppelin/pull/3225

Modified:
    zeppelin/site/docs/0.8.0/usage/rest_api/interpreter.html
    zeppelin/site/docs/0.8.0/usage/rest_api/notebook.html
    zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/interpreter.html
    zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/notebook.html

Modified: zeppelin/site/docs/0.8.0/usage/rest_api/interpreter.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0/usage/rest_api/interpreter.html?rev=1846764&r1=1846763&r2=1846764&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0/usage/rest_api/interpreter.html (original)
+++ zeppelin/site/docs/0.8.0/usage/rest_api/interpreter.html Fri Nov 16 20:29:56 2018
@@ -556,7 +556,7 @@ Note that Apache Zeppelin REST APIs rece
       <td>
         <pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: {
     &quot;id&quot;: &quot;2AYW25ANY&quot;,

Modified: zeppelin/site/docs/0.8.0/usage/rest_api/notebook.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.8.0/usage/rest_api/notebook.html?rev=1846764&r1=1846763&r2=1846764&view=diff
==============================================================================
--- zeppelin/site/docs/0.8.0/usage/rest_api/notebook.html (original)
+++ zeppelin/site/docs/0.8.0/usage/rest_api/notebook.html Fri Nov 16 20:29:56 2018
@@ -374,7 +374,7 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
@@ -594,7 +594,7 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
@@ -709,7 +709,7 @@ If you work with Apache Zeppelin and fin
       <td>sample JSON response</td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
@@ -897,7 +897,7 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;20151218-100330_1754029574&quot;
 }</pre></td>
@@ -1427,7 +1427,8 @@ If you work with Apache Zeppelin and fin
     <col width="200">
     <tr>
       <td>Description</td>
-      <td>This <code>POST</code> method adds cron job by the given note id.
+      <td>This <code>POST</code> method adds cron job by the given note id. 
+          Default value of <code>releaseResource</code> is <code>false</code>.
       </td>
     </tr>
     <tr>
@@ -1444,7 +1445,7 @@ If you work with Apache Zeppelin and fin
     </tr>
     <tr>
       <td> sample JSON input </td>
-      <td><pre>{&quot;cron&quot;: &quot;cron expression of note&quot;}</pre></td>
+      <td><pre>{&quot;cron&quot;: &quot;cron expression of note&quot;, &quot;releaseResource&quot;: &quot;false&quot;}</pre></td>
     </tr>
     <tr>
       <td> sample JSON response </td>
@@ -1490,7 +1491,7 @@ If you work with Apache Zeppelin and fin
     <tr>
       <td>Description</td>
       <td>This <code>GET</code> method gets cron job expression of given note id.
-          The body field of the returned JSON contains the cron expression.
+          The body field of the returned JSON contains the cron expression and <code>releaseResource</code> flag.
       </td>
     </tr>
     <tr>
@@ -1507,7 +1508,14 @@ If you work with Apache Zeppelin and fin
     </tr>
     <tr>
       <td> sample JSON response </td>
-      <td><pre>{&quot;status&quot;: &quot;OK&quot;, &quot;body&quot;: &quot;* * * * * ?&quot;}</pre></td>
+      <td><pre>
+{
+   &quot;status&quot;: &quot;OK&quot;, 
+   &quot;body&quot;: {
+      &quot;cron&quot;: &quot;0 0/1 * * * ?&quot;, 
+      &quot;releaseResource&quot;: true
+   }
+}</pre></td>
     </tr>
   </table></p>
 

Modified: zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/interpreter.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/interpreter.html?rev=1846764&r1=1846763&r2=1846764&view=diff
==============================================================================
--- zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/interpreter.html (original)
+++ zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/interpreter.html Fri Nov 16 20:29:56 2018
@@ -179,10 +179,12 @@
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/flink.html">Flink</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/geode.html">Geode</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/groovy.html">Groovy</a></li>
+                <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hbase.html">HBase</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hdfs.html">HDFS</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hive.html">Hive</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/ignite.html">Ignite</a></li>
+                <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/java.html">Java</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/kylin.html">Kylin</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/lens.html">Lens</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/livy.html">Livy</a></li>
@@ -556,7 +558,7 @@ Note that Apache Zeppelin REST APIs rece
       <td>
         <pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: {
     &quot;id&quot;: &quot;2AYW25ANY&quot;,

Modified: zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/notebook.html
URL: http://svn.apache.org/viewvc/zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/notebook.html?rev=1846764&r1=1846763&r2=1846764&view=diff
==============================================================================
--- zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/notebook.html (original)
+++ zeppelin/site/docs/0.9.0-SNAPSHOT/usage/rest_api/notebook.html Fri Nov 16 20:29:56 2018
@@ -179,10 +179,12 @@
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/flink.html">Flink</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/geode.html">Geode</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/groovy.html">Groovy</a></li>
+                <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hazelcastjet.html">Hazelcast Jet</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hbase.html">HBase</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hdfs.html">HDFS</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/hive.html">Hive</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/ignite.html">Ignite</a></li>
+                <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/java.html">Java</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/kylin.html">Kylin</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/lens.html">Lens</a></li>
                 <li><a href="/docs/0.9.0-SNAPSHOT/interpreter/livy.html">Livy</a></li>
@@ -374,7 +376,7 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
@@ -594,13 +596,50 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
     </tr>
   </table></p>
 
+<p><br/></p>
+
+<h3>Rename a note</h3>
+
+<p><table class="table-configuration">
+    <col width="200">
+    <tr>
+      <td>Description</td>
+      <td>This <code>PUT</code> method renames a note by the given id using the given name.
+      </td>
+    </tr>
+    <tr>
+      <td>URL</td>
+      <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/rename</code></td>
+    </tr>
+    <tr>
+      <td>Success code</td>
+      <td>200</td>
+    </tr>
+    <tr>
+       <td>Bad Request code</td>
+       <td>400</td>
+    </tr>
+    <tr>
+      <td> Fail code</td>
+      <td> 500 </td>
+    </tr>
+    <tr>
+      <td> sample JSON input </td>
+      <td><pre>{&quot;name&quot;: &quot;new name of a note&quot;}</pre></td>
+    </tr>
+    <tr>
+      <td> sample JSON response </td>
+      <td><pre>{&quot;status&quot;:&quot;OK&quot;}</pre></td>
+    </tr>
+  </table></p>
+
 <p><br /></p>
 
 <h3>Export a note</h3>
@@ -709,7 +748,7 @@ If you work with Apache Zeppelin and fin
       <td>sample JSON response</td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;2AZPHY918&quot;
 }</pre></td>
@@ -897,7 +936,7 @@ If you work with Apache Zeppelin and fin
       <td> sample JSON response </td>
       <td><pre>
 {
-  &quot;status&quot;: &quot;CREATED&quot;,
+  &quot;status&quot;: &quot;OK&quot;,
   &quot;message&quot;: &quot;&quot;,
   &quot;body&quot;: &quot;20151218-100330_1754029574&quot;
 }</pre></td>
@@ -1427,7 +1466,8 @@ If you work with Apache Zeppelin and fin
     <col width="200">
     <tr>
       <td>Description</td>
-      <td>This <code>POST</code> method adds cron job by the given note id.
+      <td>This <code>POST</code> method adds cron job by the given note id. 
+          Default value of <code>releaseResource</code> is <code>false</code>.
       </td>
     </tr>
     <tr>
@@ -1444,7 +1484,7 @@ If you work with Apache Zeppelin and fin
     </tr>
     <tr>
       <td> sample JSON input </td>
-      <td><pre>{&quot;cron&quot;: &quot;cron expression of note&quot;}</pre></td>
+      <td><pre>{&quot;cron&quot;: &quot;cron expression of note&quot;, &quot;releaseResource&quot;: &quot;false&quot;}</pre></td>
     </tr>
     <tr>
       <td> sample JSON response </td>
@@ -1490,7 +1530,7 @@ If you work with Apache Zeppelin and fin
     <tr>
       <td>Description</td>
       <td>This <code>GET</code> method gets cron job expression of given note id.
-          The body field of the returned JSON contains the cron expression.
+          The body field of the returned JSON contains the cron expression and <code>releaseResource</code> flag.
       </td>
     </tr>
     <tr>
@@ -1507,7 +1547,14 @@ If you work with Apache Zeppelin and fin
     </tr>
     <tr>
       <td> sample JSON response </td>
-      <td><pre>{&quot;status&quot;: &quot;OK&quot;, &quot;body&quot;: &quot;* * * * * ?&quot;}</pre></td>
+      <td><pre>
+{
+   &quot;status&quot;: &quot;OK&quot;, 
+   &quot;body&quot;: {
+      &quot;cron&quot;: &quot;0 0/1 * * * ?&quot;, 
+      &quot;releaseResource&quot;: true
+   }
+}</pre></td>
     </tr>
   </table></p>