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 2016/02/01 03:03:48 UTC
svn commit: r1727882 [2/2] - in
/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT: ./
assets/themes/zeppelin/img/docs-img/ development/ displaysystem/ install/
interpreter/ manual/ rest-api/ storage/ tutorial/
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html Mon Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
Added: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html?rev=1727882&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html (added)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html Mon Feb 1 02:03:47 2016
@@ -0,0 +1,311 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Configuration REST API</title>
+ <meta name="description" content="">
+ <meta name="author" content="The Apache Software Foundation">
+
+ <!-- Enable responsive viewport -->
+ <meta name="viewport" content="width=device-width, initial-scale=1.0">
+
+ <!-- Le HTML5 shim, for IE6-8 support of HTML elements -->
+ <!--[if lt IE 9]>
+ <script src="http://html5shim.googlecode.com/svn/trunk/html5.js"></script>
+ <![endif]-->
+
+ <!-- Le styles -->
+ <link href="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/css/syntax.css" rel="stylesheet" type="text/css" media="screen" />
+ <!-- Le fav and touch icons -->
+ <!-- Update these with your own images
+ <link rel="shortcut icon" href="images/favicon.ico">
+ <link rel="apple-touch-icon" href="images/apple-touch-icon.png">
+ <link rel="apple-touch-icon" sizes="72x72" href="images/apple-touch-icon-72x72.png">
+ <link rel="apple-touch-icon" sizes="114x114" href="images/apple-touch-icon-114x114.png">
+ -->
+
+ <!-- Js -->
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+ <script src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.6.0-incubating-SNAPSHOT/assets/themes/zeppelin/js/docs.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.6.0-incubating-SNAPSHOT/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.6.0-incubating-SNAPSHOT/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div id="menu" class="navbar navbar-inverse navbar-fixed-top" role="navigation">
+ <div class="container">
+ <div class="navbar-header">
+ <button type="button" class="navbar-toggle" data-toggle="collapse" data-target=".navbar-collapse">
+ <span class="sr-only">Toggle navigation</span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ <span class="icon-bar"></span>
+ </button>
+ <a class="navbar-brand" href="/docs/0.6.0-incubating-SNAPSHOT">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ <span style="vertical-align:middle">Zeppelin</span>
+ <span style="vertical-align:baseline"><small>(0.6.0-incubating-SNAPSHOT)</small></span>
+ </a>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Quick Start <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <!-- li><span><b>Overview</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/index.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Install</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/install/install.html">Install</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/install/yarn_install.html">YARN Install</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/install/virtual_machine.html">Virtual Machine Install</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Tutorial</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Guide</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicform.html">Dynamic Form</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Interpreter <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/manual/interpreters.html">Overview</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/manual/dynamicinterpreterload.html">Dynamic Interpreter Loading</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/postgresql.html">Postgresql, hawq</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Display System <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/displaysystem/display.html">Text</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/displaysystem/display.html#html">Html</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/displaysystem/table.html">Table</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/displaysystem/angular.html">Angular</a></li>
+ </ul>
+ </li>
+ <li>
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">More <b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <!-- li><span><b>Manual</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/manual/notebookashomepage.html">Notebook as Homepage</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Notebook Storage</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html#Git">Git Storage</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html#S3">S3 Storage</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>REST API</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Development</b><span></li -->
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Configuration REST API">
+ <h1></h1>
+</div>
+-->
+
+<div class="row">
+ <div class="col-md-12">
+ <!--
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.
+-->
+
+<h2>Zeppelin REST API</h2>
+
+<p>Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality.</p>
+
+<p>All REST API are available starting with the following endpoint <code>http://[zeppelin-server]:[zeppelin-port]/api</code></p>
+
+<p>Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON viewers such as
+ <a href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc">JSONView</a></p>
+
+<p>If you work with zeppelin and find a need for an additional REST API please <a href="../../community.html">file an issue or send us mail</a> </p>
+
+<p><br /></p>
+
+<h3>Configuration REST API list</h3>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>List configurations</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all key/value pair of configurations on the server.<br/>
+ Note: For security reason, some pairs would not be shown.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/configurations/all</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>
+{<br>
+ "status":"OK",
+ "message":"",
+ "body":{<br>
+ "zeppelin.war.tempdir":"webapps",
+ "zeppelin.notebook.homescreen.hide":"false",
+ "zeppelin.interpreter.remoterunner":"bin/interpreter.sh",
+ "zeppelin.notebook.s3.user":"user",
+ "zeppelin.server.port":"8089",
+ "zeppelin.dep.localrepo":"local-repo",
+ "zeppelin.ssl.truststore.type":"JKS",
+ "zeppelin.ssl.keystore.path":"keystore",
+ "zeppelin.notebook.s3.bucket":"zeppelin",
+ "zeppelin.server.addr":"0.0.0.0",
+ "zeppelin.ssl.client.auth":"false",
+ "zeppelin.server.context.path":"/",
+ "zeppelin.ssl.keystore.type":"JKS",
+ "zeppelin.ssl.truststore.path":"truststore",
+ "zeppelin.interpreters":"org.apache.zeppelin.spark.SparkInterpreter,org.apache.zeppelin.spark.PySparkInterpreter,org.apache.zeppelin.spark.SparkSqlInterpreter,org.apache.zeppelin.spark.DepInterpreter,org.apache.zeppelin.markdown.Markdown,org.apache.zeppelin.angular.AngularInterpreter,org.apache.zeppelin.shell.ShellInterpreter,org.apache.zeppelin.hive.HiveInterpreter,org.apache.zeppelin.tajo.TajoInterpreter,org.apache.zeppelin.flink.FlinkInterpreter,org.apache.zeppelin.lens.LensInterpreter,org.apache.zeppelin.ignite.IgniteInterpreter,org.apache.zeppelin.ignite.IgniteSqlInterpreter,org.apache.zeppelin.cassandra.CassandraInterpreter,org.apache.zeppelin.geode.GeodeOqlInterpreter,org.apache.zeppelin.postgresql.PostgreSqlInterpreter,org.apache.zeppelin.phoenix.PhoenixInterpreter,org.apache.zeppelin.kylin.KylinInterpreter,org.apache.zeppelin.elasticsearch.ElasticsearchInterpreter,org.apache.zeppelin.scalding.ScaldingInterpreter",
+ "zeppelin.ssl":"false",
+ "zeppelin.notebook.autoInterpreterBinding":"true",
+ "zeppelin.notebook.homescreen":"",
+ "zeppelin.notebook.storage":"org.apache.zeppelin.notebook.repo.VFSNotebookRepo",
+ "zeppelin.interpreter.connect.timeout":"30000",
+ "zeppelin.anonymous.allowed":"true",
+ "zeppelin.server.allowed.origins":"*",
+ "zeppelin.encoding":"UTF-8"
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>List configurations (prefix match)</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all prefix matched key/value pair of configurations on the server.<br/>
+ Note: For security reason, some pairs would not be shown.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/configurations/prefix/[prefix]</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>
+{<br>
+ "status":"OK",
+ "message":"",
+ "body":{<br>
+ "zeppelin.ssl.keystore.type":"JKS",
+ "zeppelin.ssl.truststore.path":"truststore",
+ "zeppelin.ssl.truststore.type":"JKS",
+ "zeppelin.ssl.keystore.path":"keystore",
+ "zeppelin.ssl":"false",
+ "zeppelin.ssl.client.auth":"false"
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2016 The Apache Software Foundation</p>-->
+ </footer>
+ </div>
+
+
+
+
+ <script type="text/javascript">
+ (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+ (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+ m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+ })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+
+ ga('create', 'UA-45176241-5', 'zeppelin.incubator.apache.org');
+ ga('require', 'linkid', 'linkid.js');
+ ga('send', 'pageview');
+
+</script>
+
+
+
+ </body>
+</html>
+
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html Mon Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
@@ -158,7 +160,7 @@ limitations under the License.
<p>Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality.</p>
<p>All REST API are available starting with the following endpoint <code>http://[zeppelin-server]:[zeppelin-port]/api</code>.
- Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON view such as
+ Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON viewers such as
<a href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc">JSON View</a>.</p>
<p>If you work with zeppelin and find a need for an additional REST API, please <a href="http://zeppelin.incubator.apache.org/community.html">file an issue or send us mail</a>. </p>
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=1727882&r1=1727881&r2=1727882&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 Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
@@ -159,7 +161,7 @@ limitations under the License.
<p>All REST APIs are available starting with the following endpoint <code>http://[zeppelin-server]:[zeppelin-port]/api</code></p>
-<p>Note that zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewer
+<p>Note that zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers
such as <a href="https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc">JSONView</a></p>
<p>If you work with zeppelin and find a need for an additional REST API please <a href="../../community.html">file an issue or send us mail</a> </p>
@@ -168,7 +170,7 @@ limitations under the License.
<h3>Notebook REST API list</h3>
-<p>Notebooks REST API supports the following operations: List, Create, Get, Delete, Clone, Run as detailed in the following table </p>
+<p>Notebooks REST API supports the following operations: List, Create, Get, Delete, Clone, Run, Export, Import as detailed in the following table </p>
<p><table class="table-configuration">
<col width="200">
@@ -906,6 +908,114 @@ limitations under the License.
</tr>
</table></p>
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Export notebook</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method exports a notebook by the given id and gernerates a JSON
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/export/[notebookId]</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <td> sample JSON response </td>
+ <td><pre>{
+ "paragraphs": [
+ {
+ "text": "%md This is my new paragraph in my new note",
+ "dateUpdated": "Jan 8, 2016 4:49:38 PM",
+ "config": {
+ "enabled": true
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph<em>1452300578795</em>1196072540",
+ "id": "20160108-164938_1685162144",
+ "dateCreated": "Jan 8, 2016 4:49:38 PM",
+ "status": "READY",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "source note for export",
+ "id": "2B82H3RR1",
+ "angularObjects": {},
+ "config": {},
+ "info": {}
+}</pre></td>
+ </tr>
+ </table></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Export notebook</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method imports a notebook from the notebook JSON input
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook/import</code></td>
+ </tr>
+ <tr>
+ <td>Success code</td>
+ <td>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <td> sample JSON input </td>
+ <td><pre>{
+ "paragraphs": [
+ {
+ "text": "%md This is my new paragraph in my new note",
+ "dateUpdated": "Jan 8, 2016 4:49:38 PM",
+ "config": {
+ "enabled": true
+ },
+ "settings": {
+ "params": {},
+ "forms": {}
+ },
+ "jobName": "paragraph<em>1452300578795</em>1196072540",
+ "id": "20160108-164938_1685162144",
+ "dateCreated": "Jan 8, 2016 4:49:38 PM",
+ "status": "READY",
+ "progressUpdateIntervalMs": 500
+ }
+ ],
+ "name": "source note for export",
+ "id": "2B82H3RR1",
+ "angularObjects": {},
+ "config": {},
+ "info": {}
+}</pre></td>
+<tr>
+ <td> sample JSON response </td>
+ <td><pre>"status": "CREATED","message": "","body": "2AZPHY918"}</pre></td>
+ </tr>
+ </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=1727882&r1=1727881&r2=1727882&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 Feb 1 02:03:47 2016
@@ -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>2016-01-20T18:24:16-08:00</lastBuildDate>
- <pubDate>2016-01-20T18:24:16-08:00</pubDate>
+ <lastBuildDate>2016-02-01T11:03:14+09:00</lastBuildDate>
+ <pubDate>2016-02-01T11:03:14+09:00</pubDate>
<ttl>1800</ttl>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/screenshots.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/screenshots.html?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/screenshots.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/screenshots.html Mon Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/sitemap.txt
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/sitemap.txt?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/sitemap.txt (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/sitemap.txt Mon Feb 1 02:03:47 2016
@@ -21,11 +21,13 @@ http://zeppelin.incubator.apache.org/int
http://zeppelin.incubator.apache.org/interpreter/postgresql.html
http://zeppelin.incubator.apache.org/interpreter/scalding.html
http://zeppelin.incubator.apache.org/interpreter/spark.html
+http://zeppelin.incubator.apache.org/interpreter/tachyon.html
http://zeppelin.incubator.apache.org/manual/dynamicform.html
http://zeppelin.incubator.apache.org/manual/dynamicinterpreterload.html
http://zeppelin.incubator.apache.org/manual/interpreters.html
http://zeppelin.incubator.apache.org/manual/notebookashomepage.html
http://zeppelin.incubator.apache.org/pleasecontribute.html
+http://zeppelin.incubator.apache.org/rest-api/rest-configuration.html
http://zeppelin.incubator.apache.org/rest-api/rest-interpreter.html
http://zeppelin.incubator.apache.org/rest-api/rest-notebook.html
http://zeppelin.incubator.apache.org/rss.xml
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/storage/storage.html Mon Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
Modified: incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html?rev=1727882&r1=1727881&r2=1727882&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html (original)
+++ incubator/zeppelin/site/docs/0.6.0-incubating-SNAPSHOT/tutorial/tutorial.html Mon Feb 1 02:03:47 2016
@@ -92,6 +92,7 @@
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/scalding.html">Scalding</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Shell</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/interpreter/tachyon.html">Tachyon</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/pleasecontribute.html">Tajo</a></li>
</ul>
</li>
@@ -117,6 +118,7 @@
<!-- li><span><b>REST API</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-interpreter.html">Interpreter API</a></li>
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li><a href="/docs/0.6.0-incubating-SNAPSHOT/rest-api/rest-configuration.html">Configuration API</a></li>
<li role="separator" class="divider"></li>
<!-- li><span><b>Development</b><span></li -->
<li><a href="/docs/0.6.0-incubating-SNAPSHOT/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>