You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by bz...@apache.org on 2016/01/23 09:45:22 UTC
svn commit: r1726359 [11/12] - in
/incubator/zeppelin/site/docs/0.5.6-incubating: ./ assets/ assets/themes/
assets/themes/zeppelin/ assets/themes/zeppelin/bootstrap/
assets/themes/zeppelin/bootstrap/css/
assets/themes/zeppelin/bootstrap/fonts/ assets/t...
Added: incubator/zeppelin/site/docs/0.5.6-incubating/manual/notebookashomepage.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/manual/notebookashomepage.html?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/manual/notebookashomepage.html (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/manual/notebookashomepage.html Sat Jan 23 08:45:18 2016
@@ -0,0 +1,276 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Notebook as Homepage</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.5.6-incubating/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.5.6-incubating/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.5.6-incubating/assets/themes/zeppelin/js/docs.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.5.6-incubating/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating">
+ <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.5.6-incubating)</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.5.6-incubating/index.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Install</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/install/install.html">Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/install/yarn_install.html">YARN Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/tutorial/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Guide</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/postgresql.html">Postgresql, hawq</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.5.6-incubating/pleasecontribute.html">Shell</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/displaysystem/display.html">Text</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/display.html#html">Html</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/table.html">Table</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/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.5.6-incubating/storage/storage.html#Git">Git Storage</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.5.6-incubating/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Development</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Notebook as Homepage">
+ <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>Customize your zeppelin homepage</h2>
+
+<p>Zeppelin allows you to use one of the notebooks you create as your zeppelin Homepage.
+ With that you can brand your zeppelin installation,
+ adjust the instruction to your users needs and even translate to other languages.</p>
+
+<p><br /></p>
+
+<h3>How to set a notebook as your zeppelin homepage</h3>
+
+<p>The process for creating your homepage is very simple as shown below:</p>
+
+<ol>
+<li>Create a notebook using zeppelin</li>
+<li>Set the notebook id in the config file</li>
+<li><p>Restart zeppelin</p>
+
+<p><br /></p>
+
+<h4>Create a notebook using zeppelin</h4>
+
+<p>Create a new notebook using zeppelin,
+you can use <code>%md</code> interpreter for markdown content or any other interpreter you like.</p>
+
+<p>You can also use the display system to generate <a href="../displaysystem/display.html">text</a>,
+<a href="../displaysystem/display.html#html">html</a>,<a href="../displaysystem/table.html">table</a> or
+<a href="../displaysystem/angular.html">angular</a></p>
+
+<p>Run (shift+Enter) the notebook and see the output. Optionally, change the notebook view to report to hide
+the code sections.</p>
+
+<p><br /></p>
+
+<h4>Set the notebook id in the config file</h4>
+
+<p>To set the notebook id in the config file you should copy it from the last word in the notebook url </p>
+
+<p>for example</p>
+
+<p><img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_id.png" /></p>
+
+<p>Set the notebook id to the <code>ZEPPELIN_NOTEBOOK_HOMESCREEN</code> environment variable
+or <code>zeppelin.notebook.homescreen</code> property. </p>
+
+<p>You can also set the <code>ZEPPELIN_NOTEBOOK_HOMESCREEN_HIDE</code> environment variable
+or <code>zeppelin.notebook.homescreen.hide</code> property to hide the new notebook from the notebook list.</p>
+
+<p><br /></p>
+
+<h4>Restart zeppelin</h4>
+
+<p>Restart your zeppelin server</p>
+<div class="highlight"><pre><code class="text language-text" data-lang="text">./bin/zeppelin-deamon stop
+./bin/zeppelin-deamon start
+</code></pre></div>
+<h4>That's it! Open your browser and navigate to zeppelin and see your customized homepage...</h4></li>
+</ol>
+
+<p><br /></p>
+
+<h3>Show notebooks list in your custom homepage</h3>
+
+<p>If you want to display the list of notebooks on your custom zeppelin homepage all
+you need to do is use our %angular support.</p>
+
+<p><br />
+ Add the following code to a paragraph in you home page and run it... walla! you have your notebooks list.</p>
+<div class="highlight"><pre><code class="javascript language-javascript" data-lang="javascript"> <span class="nx">println</span><span class="p">(</span>
+ <span class="s2">"""%angular </span>
+<span class="s2"> <div class="</span><span class="nx">col</span><span class="o">-</span><span class="nx">md</span><span class="o">-</span><span class="mi">4</span><span class="s2">" ng-controller="</span><span class="nx">HomeCtrl</span> <span class="nx">as</span> <span class="nx">home</span><span class="s2">"></span>
+<span class="s2"> <h4>Notebooks</h4></span>
+<span class="s2"> <div></span>
+<span class="s2"> <h5><a href="" data-toggle="</span><span class="nx">modal</span><span class="s2">" data-target="</span><span class="err">#</span><span class="nx">noteNameModal</span><span class="s2">" style="</span><span class="nx">text</span><span class="o">-</span><span class="nx">decoration</span><span class="o">:</span> <span class="nx">none</span><span class="p">;</span><span class="s2">"></span>
+<span class="s2"> <i style="</span><span class="nx">font</span><span class="o">-</span><span class="nx">size</span><span class="o">:</span> <span class="mi">15</span><span class="nx">px</span><span class="p">;</span><span class="s2">" class="</span><span class="nx">icon</span><span class="o">-</span><span class="nx">notebook</span><span class="s2">"></i> Create new note</a></h5></span>
+<span class="s2"> <ul style="</span><span class="nx">list</span><span class="o">-</span><span class="nx">style</span><span class="o">-</span><span class="nx">type</span><span class="o">:</span> <span class="nx">none</span><span class="p">;</span><span class="s2">"></span>
+<span class="s2"> <li ng-repeat="</span><span class="nx">note</span> <span class="k">in</span> <span class="nx">home</span><span class="p">.</span><span class="nx">notes</span><span class="p">.</span><span class="nx">list</span> <span class="nx">track</span> <span class="nx">by</span> <span class="nx">$index</span><span class="s2">"><i style="</span><span class="nx">font</span><span class="o">-</span><span class="nx">size</span><span class="o">:</span> <span class="mi">10</span><span class="nx">px</span><span class="p">;</span><span class="s2">" class="</span><span class="nx">icon</span><span class="o">-</span><span class="nx">doc</span><span class="s2">"></i></span>
+<span class="s2"> <a style="</span><span class="nx">text</span><span class="o">-</span><span class="nx">decoration</span><span class="o">:</span> <span class="nx">none</span><span class="p">;</span><span class="s2">" href="</span><span class="err">#</span><span class="o">/</span><span class="nx">notebook</span><span class="o">/</span><span class="s2">"></a></span>
+<span class="s2"> </li></span>
+<span class="s2"> </ul></span>
+<span class="s2"> </div></span>
+<span class="s2"> </div></span>
+<span class="s2"> """</span><span class="p">)</span>
+</code></pre></div>
+<p>After running the notebook you will see output similar to this one:
+ <img src="/assets/themes/zeppelin/img/screenshots/homepage_notebook_list.png" /></p>
+
+<p>The main trick here relays in linking the <code><div></code> to the controller:</p>
+<div class="highlight"><pre><code class="javascript language-javascript" data-lang="javascript"> <span class="o"><</span><span class="nx">div</span> <span class="kr">class</span><span class="o">=</span><span class="s2">"col-md-4"</span> <span class="nx">ng</span><span class="o">-</span><span class="nx">controller</span><span class="o">=</span><span class="s2">"HomeCtrl as home"</span><span class="o">></span>
+</code></pre></div>
+<p>Once we have <code>home</code> as our controller variable in our <code><div></div></code>
+ we can use <code>home.notes.list</code> to get access to the notebook list.</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>
+
Added: incubator/zeppelin/site/docs/0.5.6-incubating/pleasecontribute.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/pleasecontribute.html?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/pleasecontribute.html (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/pleasecontribute.html Sat Jan 23 08:45:18 2016
@@ -0,0 +1,192 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Please contribute</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.5.6-incubating/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.5.6-incubating/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.5.6-incubating/assets/themes/zeppelin/js/docs.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.5.6-incubating/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating">
+ <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.5.6-incubating)</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.5.6-incubating/index.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Install</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/install/install.html">Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/install/yarn_install.html">YARN Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/tutorial/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Guide</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/postgresql.html">Postgresql, hawq</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.5.6-incubating/pleasecontribute.html">Shell</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/displaysystem/display.html">Text</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/display.html#html">Html</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/table.html">Table</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/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.5.6-incubating/storage/storage.html#Git">Git Storage</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.5.6-incubating/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Development</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Please contribute">
+ <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.
+-->
+
+<h3>Waiting for your help</h3>
+
+<p>The content does not exist yet.</p>
+
+<p>We're always welcoming contribution.</p>
+
+<p>If you're interested, please check <a href="./development/howtocontributewebsite.html">How to contribute (website)</a>.</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>
+
Added: incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-interpreter.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-interpreter.html?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-interpreter.html (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-interpreter.html Sat Jan 23 08:45:18 2016
@@ -0,0 +1,559 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Interpreter 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.5.6-incubating/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.5.6-incubating/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.5.6-incubating/assets/themes/zeppelin/js/docs.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.5.6-incubating/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating">
+ <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.5.6-incubating)</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.5.6-incubating/index.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Install</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/install/install.html">Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/install/yarn_install.html">YARN Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/tutorial/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Guide</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/postgresql.html">Postgresql, hawq</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.5.6-incubating/pleasecontribute.html">Shell</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/displaysystem/display.html">Text</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/display.html#html">Html</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/table.html">Table</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/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.5.6-incubating/storage/storage.html#Git">Git Storage</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.5.6-incubating/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Development</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Interpreter 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 view 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>Interpreter REST API list</h3>
+
+<p>The role of registered interpreters, settings and interpreters group is described <a href="../manual/interpreters.html">here</a></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>List registered interpreters</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all the registered interpreters available on the server.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter</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": {
+ "md.md": {
+ "name": "md",
+ "group": "md",
+ "className": "org.apache.zeppelin.markdown.Markdown",
+ "properties": {},
+ "path": "/zeppelin/interpreter/md"
+ },
+ "spark.spark": {
+ "name": "spark",
+ "group": "spark",
+ "className": "org.apache.zeppelin.spark.SparkInterpreter",
+ "properties": {
+ "spark.executor.memory": {
+ "defaultValue": "512m",
+ "description": "Executor memory per worker instance. ex) 512m, 32g"
+ },
+ "spark.cores.max": {
+ "defaultValue": "",
+ "description": "Total number of cores to use. Empty value uses all available core."
+ },
+ },
+ "path": "/zeppelin/interpreter/spark"
+ },
+ "spark.sql": {
+ "name": "sql",
+ "group": "spark",
+ "className": "org.apache.zeppelin.spark.SparkSqlInterpreter",
+ "properties": {
+ "zeppelin.spark.maxResult": {
+ "defaultValue": "1000",
+ "description": "Max number of SparkSQL result to display."
+ }
+ },
+ "path": "/zeppelin/interpreter/spark"
+ }
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>List interpreters settings</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method return all the interpreters settings registered on the server.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting</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": [
+ {
+ "id": "2AYUGP2D5",
+ "name": "md",
+ "group": "md",
+ "properties": {
+ "<em>empty</em>": ""
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.markdown.Markdown",
+ "name": "md"
+ }
+ ]
+ },<br>
+ {
+ "id": "2AY6GV7Q3",
+ "name": "spark",
+ "group": "spark",
+ "properties": {
+ "spark.cores.max": "",
+ "spark.executor.memory": "512m",
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.spark.SparkInterpreter",
+ "name": "spark"
+ },
+ {
+ "class": "org.apache.zeppelin.spark.SparkSqlInterpreter",
+ "name": "sql"
+ }
+ ]
+ }
+ ]
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Create an interpreter setting</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method adds a new interpreter setting using a registered interpreter to the server.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting</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
+ </td>
+ <td>
+ <pre>
+{
+ "name": "Markdown setting name",
+ "group": "md",
+ "properties": {
+ "propname": "propvalue"
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.markdown.Markdown",
+ "name": "md"
+ }
+ ]
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
+ <td> sample JSON response
+ </td>
+ <td>
+ <pre>
+{
+ "status": "CREATED",
+ "message": "",
+ "body": {
+ "id": "2AYW25ANY",
+ "name": "Markdown setting name",
+ "group": "md",
+ "properties": {
+ "propname": "propvalue"
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.markdown.Markdown",
+ "name": "md"
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Update an interpreter setting</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method updates an interpreter setting with new properties.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]</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>
+{
+ "name": "Markdown setting name",
+ "group": "md",
+ "properties": {
+ "propname": "Otherpropvalue"
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.markdown.Markdown",
+ "name": "md"
+ }
+ ]
+}
+ </pre>
+ </td>
+ </tr>
+ <tr>
+ <td> sample JSON response
+ </td>
+ <td>
+ <pre>
+{
+ "status": "OK",
+ "message": "",
+ "body": {
+ "id": "2AYW25ANY",
+ "name": "Markdown setting name",
+ "group": "md",
+ "properties": {
+ "propname": "Otherpropvalue"
+ },
+ "interpreterGroup": [
+ {
+ "class": "org.apache.zeppelin.markdown.Markdown",
+ "name": "md"
+ }
+ ]
+ }
+}
+ </pre>
+ </td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Delete an interpreter setting</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes an given interpreter setting.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]</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>Restart an interpreter</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>PUT</code> method restart the given interpreter id.</td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID]</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>
+
+ </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>
+
Added: incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-notebook.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-notebook.html?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-notebook.html (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/rest-api/rest-notebook.html Sat Jan 23 08:45:18 2016
@@ -0,0 +1,937 @@
+
+<!DOCTYPE html>
+<html lang="en">
+ <head>
+ <meta charset="utf-8">
+ <title>Notebook 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.5.6-incubating/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/docs/0.5.6-incubating/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ <script src="/docs/0.5.6-incubating/assets/themes/zeppelin/js/docs.js"></script>
+
+ <!-- atom & rss feed -->
+ <link href="/docs/0.5.6-incubating/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/docs/0.5.6-incubating/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.5.6-incubating">
+ <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.5.6-incubating)</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.5.6-incubating/index.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Install</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/install/install.html">Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/install/yarn_install.html">YARN Install</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/tutorial/tutorial.html">Tutorial</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Guide</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/manual/interpreters.html">Overview</a></li>
+ <li role="separator" class="divider"></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/cassandra.html">Cassandra</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/elasticsearch.html">Elasticsearch</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/flink.html">Flink</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/geode.html">Geode</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/hive.html">Hive</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/ignite.html">Ignite</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/lens.html">Lens</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/markdown.html">Markdown</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/postgresql.html">Postgresql, hawq</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/scalding.html">Scalding</a></li>
+ <li><a href="/docs/0.5.6-incubating/pleasecontribute.html">Shell</a></li>
+ <li><a href="/docs/0.5.6-incubating/interpreter/spark.html">Spark</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/displaysystem/display.html">Text</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/display.html#html">Html</a></li>
+ <li><a href="/docs/0.5.6-incubating/displaysystem/table.html">Table</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/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.5.6-incubating/storage/storage.html#Git">Git Storage</a></li>
+ <li><a href="/docs/0.5.6-incubating/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.5.6-incubating/rest-api/rest-interpreter.html">Interpreter API</a></li>
+ <li><a href="/docs/0.5.6-incubating/rest-api/rest-notebook.html">Notebook API</a></li>
+ <li role="separator" class="divider"></li>
+ <!-- li><span><b>Development</b><span></li -->
+ <li><a href="/docs/0.5.6-incubating/development/writingzeppelininterpreter.html">Writing Zeppelin Interpreter</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontribute.html">How to contribute (code)</a></li>
+ <li><a href="/docs/0.5.6-incubating/development/howtocontributewebsite.html">How to contribute (website)</a></li>
+ </ul>
+ </li>
+ </ul>
+ </nav><!--/.navbar-collapse -->
+ </div>
+ </div>
+
+
+ <div class="container">
+
+<!--<div class="hero-unit Notebook 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 APIs for interaction and remote activation of zeppelin functionality.</p>
+
+<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
+ 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>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><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>List notebooks</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method lists the available notebooks on your server.
+ Notebook JSON contains the <code>name</code> and <code>id</code> of all notebooks.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook</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":[{"name":"Homepage","id":"2AV4WUEMK"},{"name":"Zeppelin Tutorial","id":"2A94M5J1Z"}]}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Create notebook</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method creates a new notebook using the given name or default name if none given.
+ The body field of the returned JSON contains the new notebook id.
+ </td>
+ </tr>
+ <tr>
+ <td>URL</td>
+ <td><code>http://[zeppelin-server]:[zeppelin-port]/api/notebook</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 (without paragraphs) </td>
+ <td><pre>{ "name": "name of new notebook" }</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON input (with initial paragraphs) </td>
+ <td><pre>
+{
+ "name": "name of new notebook",
+ "paragraphs": [
+ {
+ "title": "paragraph title1",
+ "text": "paragraph text1"
+ },
+ {
+ "title": "paragraph title2",
+ "text": "paragraph text2"
+ }
+ ]
+}
+ </pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "CREATED","message": "","body": "2AZPHY918"}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<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>
+ <tr>
+ <td>Description</td>
+ <td>This <code>DELETE</code> method deletes a notebook by the given notebook id.
+ </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":""}</pre></td>
+ </tr>
+ </table></p>
+
+<p><br/></p>
+
+<p><table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Clone notebook</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>POST</code> method clones a notebook by the given id and create a new notebook using the given name
+ or default name if none given.
+ The body field of the returned JSON contains the new notebook id.
+ </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>201</td>
+ </tr>
+ <tr>
+ <td> Fail code</td>
+ <td> 500 </td>
+ </tr>
+ <tr>
+ <td> sample JSON input </td>
+ <td><pre>{"name": "name of new notebook"}</pre></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "CREATED","message": "","body": "2AZPHY918"}</pre></td>
+ </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 runs 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 stops 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 gets 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"},{"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>
+
+<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 runs 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 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>
+ </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 stops 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 adds 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 removes 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 cron job</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This <code>GET</code> method gets cron job expression of given notebook id.
+ The body field of the returned JSON contains 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>
+
+<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>
+
+
+ <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>
+
Added: incubator/zeppelin/site/docs/0.5.6-incubating/robot.txt
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/robot.txt?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/robot.txt (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/robot.txt Sat Jan 23 08:45:18 2016
@@ -0,0 +1,14 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You 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.
Added: incubator/zeppelin/site/docs/0.5.6-incubating/rss.xml
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/0.5.6-incubating/rss.xml?rev=1726359&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/0.5.6-incubating/rss.xml (added)
+++ incubator/zeppelin/site/docs/0.5.6-incubating/rss.xml Sat Jan 23 08:45:18 2016
@@ -0,0 +1,15 @@
+<?xml version="1.0" encoding="UTF-8" ?>
+<rss version="2.0">
+<channel>
+ <title>Apache Zeppelin (incubating)</title>
+ <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-23T17:35:56+09:00</lastBuildDate>
+ <pubDate>2016-01-23T17:35:56+09:00</pubDate>
+ <ttl>1800</ttl>
+
+
+
+</channel>
+</rss>