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 2015/10/14 11:26:06 UTC
svn commit: r1708568 - in /incubator/zeppelin/site/docs: index.html
rest-api/rest-interpreter.html
rest-api/rest-json/rest-json-notebook-create-response.json
rest-api/rest-json/rest-json-notebook-delete-response.json
rest-api/rest-notebook.html
Author: moon
Date: Wed Oct 14 09:26:06 2015
New Revision: 1708568
URL: http://svn.apache.org/viewvc?rev=1708568&view=rev
Log:
https://issues.apache.org/jira/browse/ZEPPELIN-333
Added:
incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-create-response.json
incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-delete-response.json
incubator/zeppelin/site/docs/rest-api/rest-notebook.html
Modified:
incubator/zeppelin/site/docs/index.html
incubator/zeppelin/site/docs/rest-api/rest-interpreter.html
Modified: incubator/zeppelin/site/docs/index.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/index.html?rev=1708568&r1=1708567&r2=1708568&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/index.html (original)
+++ incubator/zeppelin/site/docs/index.html Wed Oct 14 09:26:06 2015
@@ -160,6 +160,14 @@
+
+
+
+
+
+
+
+
@@ -265,6 +273,14 @@
+
+
+
+
+
+
+
+
<li><a href="/download.html">Download</a></li>
@@ -335,7 +351,7 @@
<p><strong><a href="manual/interpreters.html">Interpreters in zeppelin</a></strong></p>
<ul>
-<li><a href="../docs/pleasecontribute.html">flink</a></li>
+<li><a href="../docs/interpreter/flink.html">flink</a></li>
<li><a href="../docs/pleasecontribute.html">hive</a></li>
<li><a href="../docs/pleasecontribute.html">ignite</a></li>
<li><a href="../docs/pleasecontribute.html">lens</a></li>
@@ -367,7 +383,7 @@
<ul>
<li><a href="./rest-api/rest-interpreter.html">Interpreter API</a></li>
-<li><a href="../docs/pleasecontribute.html">Notebook API</a></li>
+<li><a href="./rest-api/rest-notebook.html">Notebook API</a></li>
</ul>
<h3>Development</h3>
Modified: incubator/zeppelin/site/docs/rest-api/rest-interpreter.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/rest-api/rest-interpreter.html?rev=1708568&r1=1708567&r2=1708568&view=diff
==============================================================================
--- incubator/zeppelin/site/docs/rest-api/rest-interpreter.html (original)
+++ incubator/zeppelin/site/docs/rest-api/rest-interpreter.html Wed Oct 14 09:26:06 2015
@@ -160,6 +160,14 @@
+
+
+
+
+
+
+
+
@@ -265,6 +273,14 @@
+
+
+
+
+
+
+
+
<li><a href="/download.html">Download</a></li>
@@ -323,7 +339,7 @@
<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 recomended you install some JSON view such as
+<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>
Added: incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-create-response.json
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-create-response.json?rev=1708568&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-create-response.json (added)
+++ incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-create-response.json Wed Oct 14 09:26:06 2015
@@ -0,0 +1 @@
+{"status": "CREATED","message": "","body": "2AZPHY918"}
\ No newline at end of file
Added: incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-delete-response.json
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-delete-response.json?rev=1708568&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-delete-response.json (added)
+++ incubator/zeppelin/site/docs/rest-api/rest-json/rest-json-notebook-delete-response.json Wed Oct 14 09:26:06 2015
@@ -0,0 +1 @@
+{"status":"OK","message":""}
\ No newline at end of file
Added: incubator/zeppelin/site/docs/rest-api/rest-notebook.html
URL: http://svn.apache.org/viewvc/incubator/zeppelin/site/docs/rest-api/rest-notebook.html?rev=1708568&view=auto
==============================================================================
--- incubator/zeppelin/site/docs/rest-api/rest-notebook.html (added)
+++ incubator/zeppelin/site/docs/rest-api/rest-notebook.html Wed Oct 14 09:26:06 2015
@@ -0,0 +1,487 @@
+
+<!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="/assets/themes/zeppelin/bootstrap/css/bootstrap.css" rel="stylesheet">
+ <link href="/assets/themes/zeppelin/css/style.css?body=1" rel="stylesheet" type="text/css">
+ <link href="/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">
+ -->
+
+ <!-- atom & rss feed -->
+ <link href="/atom.xml" type="application/atom+xml" rel="alternate" title="Sitewide ATOM Feed">
+ <link href="/rss.xml" type="application/rss+xml" rel="alternate" title="Sitewide RSS Feed">
+ </head>
+
+ <body>
+
+ <div 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="/">
+ <img src="/assets/themes/zeppelin/img/zeppelin_logo.png" width="50" alt="I'm zeppelin">
+ Apache Zeppelin <small>(incubating)</small>
+ </a>
+ </div>
+ <nav class="navbar-collapse collapse" role="navigation">
+ <ul class="nav navbar-nav">
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </ul>
+ <ul class="nav navbar-nav navbar-right">
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/community.html">Community</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/docs/index.html">Docs</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="/download.html">Download</a></li>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ <li><a href="https://github.com/apache/incubator-zeppelin">GitHub</a></li>
+ <li id="apache">
+ <a href="#" data-toggle="dropdown" class="dropdown-toggle">Apache<b class="caret"></b></a>
+ <ul class="dropdown-menu">
+ <li><a href="http://www.apache.org/foundation/how-it-works.html">Apache Software Foundation</a></li>
+ <li><a href="http://www.apache.org/licenses/">Apache License</a></li>
+ <li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li>
+ <li><a href="http://www.apache.org/foundation/thanks.html">Thanks</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">
+ <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>Notebook REST API list</h3>
+
+<p>Notebooks can be created, deleted or cloned using the following REST API</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 create a new notebook using the given name or default name if none given.
+ The body field of the returned JSON contain 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 </td>
+ <td> <a href="rest-json/rest-json-notebook-create.json">Create JSON sample</a></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td> <a href="rest-json/rest-json-notebook-create-response.json">Create response sample</a> </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 delete 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> <a href="rest-json/rest-json-notebook-delete-response.json">Delete response sample</a> </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 clone 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 contain 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> <a href="rest-json/rest-json-notebook-create.json">Clone JSON sample</a></td>
+ </tr>
+ <tr>
+ <td> sample JSON response </td>
+ <td> <a href="rest-json/rest-json-notebook-create-response.json">Clone response sample</a> </td>
+ </tr>
+ </table></p>
+
+ </div>
+</div>
+
+
+ <hr>
+ <footer>
+ <!-- <p>© 2015 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>
+
+
+
+ <script src="https://code.jquery.com/jquery-1.10.2.min.js"></script>
+
+ <script src="/assets/themes/zeppelin/bootstrap/js/bootstrap.min.js"></script>
+ </body>
+</html>
+