You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by kh...@apache.org on 2017/06/23 08:41:39 UTC
[05/10] zeppelin git commit: [ZEPPELIN-2596] Improving documentation
page
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/rest-api/rest-helium.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-helium.md b/docs/rest-api/rest-helium.md
deleted file mode 100644
index b78b576..0000000
--- a/docs/rest-api/rest-helium.md
+++ /dev/null
@@ -1,378 +0,0 @@
----
-layout: page
-title: "Apache Zeppelin Helium REST API"
-description: "This page contains Apache Zeppelin Helium REST API information."
-group: rest-api
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Apache Zeppelin Helium REST API
-
-<div id="toc"></div>
-
-## Overview
-Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
-All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
-Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
-
-If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html).
-
-## Helium REST API List
-
-### List of all available helium packages
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns all the available helium packages in configured registries.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/all```</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": {
- "zeppelin.clock": [
- {
- "registry": "local",
- "pkg": {
- "type": "APPLICATION",
- "name": "zeppelin.clock",
- "description": "Clock (example)",
- "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar",
- "className": "org.apache.zeppelin.example.app.clock.Clock",
- "resources": [
- [
- ":java.util.Date"
- ]
- ],
- "icon": "icon"
- },
- "enabled": false
- }
- ],
- "zeppelin-bubblechart": [
- {
- "registry": "local",
- "pkg": {
- "type": "VISUALIZATION",
- "name": "zeppelin-bubblechart",
- "description": "Animated bubble chart",
- "artifact": ".\/..\/helium\/zeppelin-bubble",
- "icon": "icon"
- },
- "enabled": true
- },
- {
- "registry": "local",
- "pkg": {
- "type": "VISUALIZATION",
- "name": "zeppelin-bubblechart",
- "description": "Animated bubble chart",
- "artifact": "zeppelin-bubblechart@0.0.2",
- "icon": "icon"
- },
- "enabled": false
- }
- ],
- "zeppelin\_horizontalbar": [
- {
- "registry": "local",
- "pkg": {
- "type": "VISUALIZATION",
- "name": "zeppelin_horizontalbar",
- "description": "Horizontal Bar chart (example)",
- "artifact": ".\/zeppelin-examples\/zeppelin-example-horizontalbar",
- "icon": "icon"
- },
- "enabled": true
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Suggest Helium application
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns suggested helium application for the paragraph.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/suggest/[Note ID]/[Paragraph ID]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 404 on note or paragraph not exists <br />
- 500
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK",
- "message": "",
- "body": {
- "available": [
- {
- "registry": "local",
- "pkg": {
- "type": "APPLICATION",
- "name": "zeppelin.clock",
- "description": "Clock (example)",
- "artifact": "zeppelin-examples\/zeppelin-example-clock\/target\/zeppelin-example-clock-0.7.0-SNAPSHOT.jar",
- "className": "org.apache.zeppelin.example.app.clock.Clock",
- "resources": [
- [
- ":java.util.Date"
- ]
- ],
- "icon": "icon"
- },
- "enabled": true
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Load helium Application on a paragraph
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns a helium Application id on success.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/load/[Note ID]/[Paragraph ID]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 404 on note or paragraph not exists <br/>
- 500 for any other errors
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK",
- "message": "",
- "body": "app_2C5FYRZ1E-20170108-040449_2068241472zeppelin_clock"
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Load bundled visualization script
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns bundled helium visualization javascript. When refresh=true (optional) is provided, Zeppelin rebuild bundle. otherwise, provided from cache</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizations/load[?refresh=true]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200 reponse body is executable javascript</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 200 reponse body is error message string starts with ERROR:<br/>
- </td>
- </tr>
- </table>
-
-<br/>
-### Enable package
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method enables a helium package. Needs artifact name in input payload</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/enable/[Package Name]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td> 500 </td>
- </tr>
- <tr>
- <td>Sample input</td>
- <td>
- <pre>
-zeppelin-examples/zeppelin-example-clock/target/zeppelin-example-clock-0.7.0-SNAPSHOT.jar
- </pre>
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <pre>
-{"status":"OK"}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Disable package
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method disables a helium package.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/disable/[Package Name]```</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>
- <code>{"status":"OK"}</code>
- </td>
- </tr>
- </table>
-<br />
-
-### Get visualization display order
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns display order of enabled visualization packages.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder```</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>
- <code>{"status":"OK","body":["zeppelin_horizontalbar","zeppelin-bubblechart"]}</code>
- </td>
- </tr>
- </table>
-
-
-<br />
-
-### Set visualization display order
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method sets visualization packages display order.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/helium/visualizationOrder```</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>
- <code>["zeppelin-bubblechart", "zeppelin_horizontalbar"]</code>
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <code>{"status":"OK"}</code>
- </td>
- </tr>
- </table>
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/rest-api/rest-interpreter.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-interpreter.md b/docs/rest-api/rest-interpreter.md
deleted file mode 100644
index d7dc6dd..0000000
--- a/docs/rest-api/rest-interpreter.md
+++ /dev/null
@@ -1,543 +0,0 @@
----
-layout: page
-title: "Apache Zeppelin Interpreter REST API"
-description: "This page contains Apache Zeppelin Interpreter REST API information."
-group: rest-api
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Apache Zeppelin Interpreter REST API
-
-<div id="toc"></div>
-
-## Overview
-Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
-All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
-Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
-
-If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html).
-
-## Interpreter REST API List
-
-The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
-
-### List of registered interpreters
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns all the registered interpreters available on the server.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter```</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": "1g",
- "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 Spark SQL result to display."
- }
- },
- "path": "/zeppelin/interpreter/spark"
- }
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### List of registered interpreter settings
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns all the interpreters settings registered on the server.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```</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": {
- "_empty_": ""
- },
- "interpreterGroup": [
- {
- "class": "org.apache.zeppelin.markdown.Markdown",
- "name": "md"
- }
- ],
- "dependencies": []
- },
- {
- "id": "2AY6GV7Q3",
- "name": "spark",
- "group": "spark",
- "properties": {
- "spark.cores.max": "",
- "spark.executor.memory": "1g",
- },
- "interpreterGroup": [
- {
- "class": "org.apache.zeppelin.spark.SparkInterpreter",
- "name": "spark"
- },
- {
- "class": "org.apache.zeppelin.spark.SparkSqlInterpreter",
- "name": "sql"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "com.databricks:spark-csv_2.10:1.3.0"
- }
- ]
- }
- ]
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Get a registered interpreter setting by the setting id
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns a registered interpreter setting on the server.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[setting ID]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 400 if such interpreter setting id does not exist <br/>
- 500 for any other errors
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK",
- "message": "",
- "body": {
- "id": "2AYW25ANY",
- "name": "Markdown setting name",
- "group": "md",
- "properties": {
- "propname": "propvalue"
- },
- "interpreterGroup": [
- {
- "class": "org.apache.zeppelin.markdown.Markdown",
- "name": "md"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "groupId:artifactId:version",
- "exclusions": [
- "groupId:artifactId"
- ]
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Create a new interpreter setting
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method adds a new interpreter setting using a registered interpreter to the server.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 400 if the input json is empty <br/>
- 500 for any other errors
- </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"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "groupId:artifactId:version",
- "exclusions": [
- "groupId:artifactId"
- ]
- }
- ]
-}
- </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"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "groupId:artifactId:version",
- "exclusions": [
- "groupId:artifactId"
- ]
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Update an interpreter setting
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method updates an interpreter setting with new properties.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```</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"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "groupId:artifactId:version",
- "exclusions": [
- "groupId:artifactId"
- ]
- }
- ]
-}
- </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"
- }
- ],
- "dependencies": [
- {
- "groupArtifactVersion": "groupId:artifactId:version",
- "exclusions": [
- "groupId:artifactId"
- ]
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Delete an interpreter setting
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method deletes an given interpreter setting.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/[interpreter ID]```</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>
- <code>{"status":"OK"}</code>
- </td>
- </tr>
- </table>
-
-
-<br/>
-### Restart an interpreter
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method restarts the given interpreter id.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/setting/restart/[interpreter ID]```</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)</td>
- <td>
- <pre>
-{
- "noteId": "2AVQJVC8N"
-}
- </pre>
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <code>{"status":"OK"}</code>
- </td>
- </tr>
- </table>
-
-<br/>
-### Add a new repository for dependency resolving
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method adds new repository.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository```</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>
-{
- "id": "securecentral",
- "url": "https://repo1.maven.org/maven2",
- "snapshot": false
-}
- </pre>
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <code>{"status":"OK"}</code>
- </td>
- </tr>
- </table>
-
-<br/>
-### Delete a repository for dependency resolving
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method delete repository with given id.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/interpreter/repository/[repository ID]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td> 500 </td>
- </tr>
- </table>
-
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/rest-api/rest-notebook.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-notebook.md b/docs/rest-api/rest-notebook.md
deleted file mode 100644
index 1c5ebde..0000000
--- a/docs/rest-api/rest-notebook.md
+++ /dev/null
@@ -1,1277 +0,0 @@
----
-layout: page
-title: "Apache Zeppelin Notebook REST API"
-description: "This page contains Apache Zeppelin Notebook REST API information."
-group: rest-api
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Apache Zeppelin Notebook REST API
-
-<div id="toc"></div>
-
-## Overview
-Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
-All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
-Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
-If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html).
-
-Notebooks REST API supports the following operations: List, Create, Get, Delete, Clone, Run, Export, Import as detailed in the following tables.
-
-## Note operations
-### List of the notes
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method lists the available notes on your server.
- Notebook JSON contains the ```name``` and ```id``` of all notes.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook```</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>
-
-<br/>
-### Create a new note
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method creates a new note using the given name or default name if none given.
- The body field of the returned JSON contains the new note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook```</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 (without paragraphs) </td>
- <td><pre>{"name": "name of new note"}</pre></td>
- </tr>
- <tr>
- <td> sample JSON input (with initial paragraphs) </td>
- <td><pre>
-{
- "name": "name of new note",
- "paragraphs": [
- {
- "title": "paragraph title1",
- "text": "paragraph text1"
- },
- {
- "title": "paragraph title2",
- "text": "paragraph text2",
- "config": {
- "title": true,
- "colWidth": 6.0,
- "results": [
- {
- "graph": {
- "mode": "scatterChart",
- "optionOpen": true
- }
- }
- ]
- }
- }
- ]
-}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>
-{
- "status": "CREATED",
- "message": "",
- "body": "2AZPHY918"
-}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Get the status of all paragraphs
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method gets the status of all paragraphs by the given note 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>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]```</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\_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\_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>
-
-<br/>
-### Get an existing note information
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method retrieves an existing note's information using the given id.
- The body field of the returned JSON contain information about paragraphs in the note.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]```</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\_1423500782552\_-1439281894",
- "id": "20150210-015302\_1492795503",
- "results": {
- "code": "SUCCESS",
- "msg": [
- {
- "type": "TABLE",
- "data": "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>
-
-<br/>
-### Delete a note
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method deletes a note by the given note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]```</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>
-
-<br/>
-### Clone a note
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method clones a note by the given id and create a new note using the given name
- or default name if none given.
- The body field of the returned JSON contains the new note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]```</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": "name of new note"}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>
-{
- "status": "CREATED",
- "message": "",
- "body": "2AZPHY918"
-}</pre></td>
- </tr>
- </table>
-
-<br />
-### Export a note
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method exports a note by the given id and gernerates a JSON
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/export/[noteId]```</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\_1452300578795\_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>
-
-<br />
-### Import a note
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method imports a note from the note JSON input
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/import```</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>
-{
- "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\_1452300578795\_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>
- <tr>
- <td>sample JSON response</td>
- <td><pre>
-{
- "status": "CREATED",
- "message": "",
- "body": "2AZPHY918"
-}</pre></td>
- </tr>
- </table>
-
-### Run all paragraphs
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>
- This ```POST``` method runs all paragraphs in the given note id. <br />
- If you can not find Note id 404 returns.
- If there is a problem with the interpreter returns a 412 error.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td> Fail code</td>
- <td> 404 or 412</td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- <tr>
- <td> sample JSON error response </td>
- <td>
- <pre>
- {
- "status": "NOT_FOUND",
- "message": "note not found."
- }
- </pre><br />
- <pre>
- {
- "status": "PRECONDITION_FAILED",
- "message": "paragraph_1469771130099_-278315611 Not selected or Invalid Interpreter bind"
- }
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-### Stop all paragraphs
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method stops all paragraphs in the given note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]```</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>
-
-<br />
-### Clear all paragraph result
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method clear all paragraph results from note of given id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/clear```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Forbidden code</td>
- <td>401</td>
- </tr>
- <tr>
- <td>Not Found code</td>
- <td>404</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>500</td>
- </tr>
- <tr>
- <td>sample JSON response</td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- </tr>
- </table>
-
-
-## Paragraph operations
-<br/>
-### Create a new paragraph
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` 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>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph```</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 input (providing paragraph config) </td>
- <td><pre>
-{
- "title": "paragraph title2",
- "text": "paragraph text2",
- "config": {
- "title": true,
- "colWidth": 6.0,
- "results": [
- {
- "graph": {
- "mode": "pieChart",
- "optionOpen": true
- }
- }
- ]
- }
-}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>
-{
- "status": "CREATED",
- "message": "",
- "body": "20151218-100330\_1754029574"
-}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Get a paragraph information
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` 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>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]```</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\_1450391574392\_-1890856722",
- "id": "20151218-073254\_1105602047",
- "results": {
- "code": "SUCCESS",
- "msg": [
- {
- "type": "TEXT",
- "data": "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>
-
-<br/>
-### Get the status of a single paragraph
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method gets the status of a single paragraph by the given note and paragraph 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>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</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\_766735423",
- "status":"FINISHED",
- "finished":"Tue Nov 24 14:21:40 KST 2015",
- "started":"Tue Nov 24 14:21:39 KST 2015"
- }
-}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Update paragraph configuration
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method update paragraph configuration using given id so that user can change paragraph setting such as graph type, show or hide editor/result and paragraph size, etc. You can update certain fields you want, for example you can update <code>colWidth</code> field only by sending request with payload <code>{"colWidth": 12.0}</code>.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/config```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Bad Request code</td>
- <td>400</td>
- </tr>
- <tr>
- <td>Forbidden code</td>
- <td>403</td>
- </tr>
- <tr>
- <td>Not Found code</td>
- <td>404</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>500</td>
- </tr>
- <tr>
- <td>sample JSON input</td>
- <td><pre>
-{
- "colWidth": 6.0,
- "graph": {
- "mode": "lineChart",
- "height": 200.0,
- "optionOpen": false,
- "keys": [
- {
- "name": "age",
- "index": 0.0,
- "aggr": "sum"
- }
- ],
- "values": [
- {
- "name": "value",
- "index": 1.0,
- "aggr": "sum"
- }
- ],
- "groups": [],
- "scatter": {}
- },
- "editorHide": true,
- "editorMode": "ace/mode/markdown",
- "tableHide": false
-}</pre></td>
- </tr>
- <tr>
- <td>sample JSON response</td>
- <td><pre>
-{
- "status":"OK",
- "message":"",
- "body":{
- "text":"%sql \nselect age, count(1) value\nfrom bank \nwhere age \u003c 30 \ngroup by age \norder by age",
- "config":{
- "colWidth":6.0,
- "graph":{
- "mode":"lineChart",
- "height":200.0,
- "optionOpen":false,
- "keys":[
- {
- "name":"age",
- "index":0.0,
- "aggr":"sum"
- }
- ],
- "values":[
- {
- "name":"value",
- "index":1.0,
- "aggr":"sum"
- }
- ],
- "groups":[],
- "scatter":{}
- },
- "tableHide":false,
- "editorMode":"ace/mode/markdown",
- "editorHide":true
- },
- "settings":{
- "params":{},
- "forms":{}
- },
- "apps":[],
- "jobName":"paragraph_1423500782552_-1439281894",
- "id":"20150210-015302_1492795503",
- "results":{
- "code":"SUCCESS",
- "msg": [
- {
- "type":"TABLE",
- "data":"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
- }
-}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Delete a paragraph
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method deletes a paragraph by the given note and paragraph id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]```</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>
-
-<br/>
-### Run a paragraph asynchronously
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method runs the paragraph asynchronously by given note and paragraph id. This API always return SUCCESS even if the execution of the paragraph fails later because the API is asynchronous
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</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 note",
- "params": {
- "formLabel1": "value1",
- "formLabel2": "value2"
- }
-}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Run a paragraph synchronously
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method runs the paragraph synchronously by given note and paragraph id. This API can return SUCCESS or ERROR depending on the outcome of the paragraph execution
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/run/[noteId]/[paragraphId]```</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 note",
- "params": {
- "formLabel1": "value1",
- "formLabel2": "value2"
- }
-}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- <tr>
- <td> sample JSON error </td>
- <td><pre>
-{
- "status": "INTERNAL\_SERVER\_ERROR",
- "body": {
- "code": "ERROR",
- "type": "TEXT",
- "msg": "bash: -c: line 0: unexpected EOF while looking for matching ``'\nbash: -c: line 1: syntax error: unexpected end of file\nExitValue: 2"
- }
-}</pre></td>
- </tr>
- </table>
-
-<br/>
-### Stop a paragraph
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method stops the paragraph by given note and paragraph id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</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>
-
-<br/>
-### Move a paragraph to the specific index
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method moves a paragraph to the specific index (order) from the note.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/move/[newIndex]```</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>
-
-<br />
-### Full text search through the paragraphs in all notes
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>```GET``` request will return list of matching paragraphs
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/search?q=[query]```</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":"Note Name",
- "snippet":"",
- "text":""
- }
- ]
-}</pre></td>
- </tr>
- </table>
-
-## Cron jobs
-<br/>
-### Add Cron Job
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```POST``` method adds cron job by the given note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</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 note"}</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- </table>
-
-<br/>
-
-### Remove Cron Job
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```DELETE``` method removes cron job by the given note id.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</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>
-
-<br/>
-
-### Get Cron Job
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method gets cron job expression of given note id.
- The body field of the returned JSON contains the cron expression.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</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>
-
-## Permission
-
-
-
-### Get a note permission information
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method gets a note authorization information.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Forbidden code</td>
- <td>403</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>500</td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>
-{
- "status":"OK",
- "message":"",
- "body":{
- "readers":[
- "user2"
- ],
- "owners":[
- "user1"
- ],
- "writers":[
- "user2"
- ]
- }
-}
- </pre></td>
- </tr>
- </table>
-
-<br/>
-### Set note permission
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method set note authorization information.
- </td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Forbidden code</td>
- <td>403</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>500</td>
- </tr>
- <tr>
- <td> sample JSON input </td>
- <td><pre>
-{
- "readers": [
- "user1"
- ],
- "owners": [
- "user2"
- ],
- "writers": [
- "user1"
- ]
-}
-</pre></td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>
-{
- "status": "OK"
-}</pre></td>
- </tr>
- </table>
-
-
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/rest-api/rest-notebookRepo.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-notebookRepo.md b/docs/rest-api/rest-notebookRepo.md
deleted file mode 100644
index a11d387..0000000
--- a/docs/rest-api/rest-notebookRepo.md
+++ /dev/null
@@ -1,179 +0,0 @@
----
-layout: page
-title: "Apache Zeppelin notebook repository REST API"
-description: "This page contains Apache Zeppelin notebook repository REST API information."
-group: rest-api
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Apache Zeppelin Notebook Repository API
-
-<div id="toc"></div>
-
-## Overview
-Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
-All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
-Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
-
-If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html).
-
-## Notebook Repository REST API List
-
-### List all available notebook repositories
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns all the available notebook repositories.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories```</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": "GitNotebookRepo",
- "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
- "settings": [
- {
- "type": "INPUT",
- "value": [],
- "selected": "ZEPPELIN_HOME/zeppelin/notebook/",
- "name": "Notebook Path"
- }
- ]
- }
- ]
-}
- </pre>
- </td>
- </tr>
- </table>
-
-<br/>
-
-### Reload a notebook repository
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method triggers reloading and broadcasting of the note list.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories/reload```</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>
-
-<br/>
-
-### Update a specific notebook repository
-
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method updates a specific notebook repository.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook-repositories```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>
- 404 when the specified notebook repository doesn't exist <br/>
- 406 for invalid payload <br/>
- 500 for any other errors
- </td>
- </tr>
- <tr>
- <td>Sample JSON input</td>
- <td>
- <pre>
-{
- "name":"org.apache.zeppelin.notebook.repo.GitNotebookRepo",
- "settings":{
- "Notebook Path":"/tmp/notebook/"
- }
-}
- </pre>
- </td>
- </tr>
- <tr>
- <td>Sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK",
- "message": "",
- "body": {
- "name": "GitNotebookRepo",
- "className": "org.apache.zeppelin.notebook.repo.GitNotebookRepo",
- "settings": [
- {
- "type": "INPUT",
- "value": [],
- "selected": "/tmp/notebook/",
- "name": "Notebook Path"
- }
- ]
- }
-}
- </pre>
- </td>
- </tr>
- </table>
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/rest-api/rest-zeppelin-server.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-zeppelin-server.md b/docs/rest-api/rest-zeppelin-server.md
deleted file mode 100644
index 0da4b6c..0000000
--- a/docs/rest-api/rest-zeppelin-server.md
+++ /dev/null
@@ -1,115 +0,0 @@
----
-layout: page
-title: "Apache Zeppelin Server REST API"
-description: "This page contains Apache Zeppelin Server REST API information."
-group: rest-api
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Apache Zeppelin Server REST API
-
-<div id="toc"></div>
-
-## Overview
-Apache Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
-All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
-Note that Apache Zeppelin REST APIs receive or return JSON objects, it is recommended for you to install some JSON viewers such as [JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
-
-If you work with Apache Zeppelin and find a need for an additional REST API, please [file an issue or send us an email](http://zeppelin.apache.org/community.html).
-
-
-## Zeppelin Server REST API list
-
-### Get Zeppelin version
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```GET``` method returns Zeppelin version</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/version```</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": "Zeppelin version",
- "body": [
- {
- "version": "0.8.0",
- "git-commit-id": "abc0123",
- "git-timestamp": "2017-01-02 03:04:05"
- }
- ]
-}
- </pre>
- </td>
- </tr>
- </table>
-
-### Change the log level of Zeppelin Server
- <table class="table-configuration">
- <col width="200">
- <tr>
- <td>Description</td>
- <td>This ```PUT``` method is used to update the root logger's log level of the server.</td>
- </tr>
- <tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/log/level/<LOG_LEVEL>```</td>
- </tr>
- <tr>
- <td>Success code</td>
- <td>200</td>
- </tr>
- <tr>
- <td>Fail code</td>
- <td>406</td>
- </tr>
- <tr>
- <td>sample JSON response</td>
- <td>
- <pre>
-{
- "status": "OK"
-}
- </pre>
- </td>
- </tr>
- <tr>
- <td>sample error JSON response</td>
- <td>
- <pre>
-{
- "status":"NOT_ACCEPTABLE",
- "message":"Please check LOG level specified. Valid values: DEBUG, ERROR, FATAL, INFO, TRACE, WARN"
-}
- </pre>
- </td>
- </tr>
- </table>
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/security/authentication.md
----------------------------------------------------------------------
diff --git a/docs/security/authentication.md b/docs/security/authentication.md
deleted file mode 100644
index 2723c56..0000000
--- a/docs/security/authentication.md
+++ /dev/null
@@ -1,132 +0,0 @@
----
-layout: page
-title: "Authentication for NGINX"
-description: "There are multiple ways to enable authentication in Apache Zeppelin. This page describes HTTP basic auth using NGINX."
-group: security
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Authentication for NGINX
-
-<div id="toc"></div>
-
-[Build in authentication mechanism](./shiroauthentication.html) is recommended way for authentication. In case of you want authenticate using NGINX and [HTTP basic auth](https://en.wikipedia.org/wiki/Basic_access_authentication), please read this document.
-
-## HTTP Basic Authentication using NGINX
-
-> **Quote from Wikipedia:** NGINX is a web server. It can act as a reverse proxy server for HTTP, HTTPS, SMTP, POP3, and IMAP protocols, as well as a load balancer and an HTTP cache.
-
-So you can use NGINX server as proxy server to serve HTTP Basic Authentication as a separate process along with Zeppelin server.
-Here are instructions how to accomplish the setup NGINX as a front-end authentication server and connect Zeppelin at behind.
-
-This instruction based on Ubuntu 14.04 LTS but may work with other OS with few configuration changes.
-
-1. Install NGINX server on your server instance
-
- You can install NGINX server with same box where zeppelin installed or separate box where it is dedicated to serve as proxy server.
-
- ```
- $ apt-get install nginx
- ```
- > **NOTE :** On pre 1.3.13 version of NGINX, Proxy for Websocket may not fully works. Please use latest version of NGINX. See: [NGINX documentation](https://www.nginx.com/blog/websocket-nginx/).
-
-1. Setup init script in NGINX
-
- In most cases, NGINX configuration located under `/etc/nginx/sites-available`. Create your own configuration or add your existing configuration at `/etc/nginx/sites-available`.
-
- ```
- $ cd /etc/nginx/sites-available
- $ touch my-zeppelin-auth-setting
- ```
-
- Now add this script into `my-zeppelin-auth-setting` file. You can comment out `optional` lines If you want serve Zeppelin under regular HTTP 80 Port.
-
- ```
- upstream zeppelin {
- server [YOUR-ZEPPELIN-SERVER-IP]:[YOUR-ZEPPELIN-SERVER-PORT]; # For security, It is highly recommended to make this address/port as non-public accessible
- }
-
- # Zeppelin Website
- server {
- listen [YOUR-ZEPPELIN-WEB-SERVER-PORT];
- listen 443 ssl; # optional, to serve HTTPS connection
- server_name [YOUR-ZEPPELIN-SERVER-HOST]; # for example: zeppelin.mycompany.com
-
- ssl_certificate [PATH-TO-YOUR-CERT-FILE]; # optional, to serve HTTPS connection
- ssl_certificate_key [PATH-TO-YOUR-CERT-KEY-FILE]; # optional, to serve HTTPS connection
-
- if ($ssl_protocol = "") {
- rewrite ^ https://$host$request_uri? permanent; # optional, to force use of HTTPS
- }
-
- location / { # For regular websever support
- proxy_pass http://zeppelin;
- proxy_set_header X-Real-IP $remote_addr;
- proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
- proxy_set_header Host $http_host;
- proxy_set_header X-NginX-Proxy true;
- proxy_redirect off;
- auth_basic "Restricted";
- auth_basic_user_file /etc/nginx/.htpasswd;
- }
-
- location /ws { # For websocket support
- proxy_pass http://zeppelin/ws;
- proxy_http_version 1.1;
- proxy_set_header Upgrade websocket;
- proxy_set_header Connection upgrade;
- proxy_read_timeout 86400;
- }
- }
- ```
-
- Then make a symbolic link to this file from `/etc/nginx/sites-enabled/` to enable configuration above when NGINX reloads.
-
- ```
- $ ln -s /etc/nginx/sites-enabled/my-zeppelin-auth-setting /etc/nginx/sites-available/my-zeppelin-auth-setting
- ```
-
-1. Setup user credential into `.htpasswd` file and restart server
-
- Now you need to setup `.htpasswd` file to serve list of authenticated user credentials for NGINX server.
-
- ```
- $ cd /etc/nginx
- $ htpasswd -c htpasswd [YOUR-ID]
- $ NEW passwd: [YOUR-PASSWORD]
- $ RE-type new passwd: [YOUR-PASSWORD-AGAIN]
- ```
- Or you can use your own apache `.htpasswd` files in other location for setting up property: `auth_basic_user_file`
-
- Restart NGINX server.
-
- ```
- $ service nginx restart
- ```
- Then check HTTP Basic Authentication works in browser. If you can see regular basic auth popup and then able to login with credential you entered into `.htpasswd` you are good to go.
-
-1. More security consideration
-
-* Using HTTPS connection with Basic Authentication is highly recommended since basic auth without encryption may expose your important credential information over the network.
-* Using [Shiro Security feature built-into Zeppelin](./shiroauthentication.html) is recommended if you prefer all-in-one solution for authentication but NGINX may provides ad-hoc solution for re-use authentication served by your system's NGINX server or in case of you need to separate authentication from zeppelin server.
-* It is recommended to isolate direct connection to Zeppelin server from public internet or external services to secure your zeppelin instance from unexpected attack or problems caused by public zone.
-
-## Another option
-
-Another option is to have an authentication server that can verify user credentials in an LDAP server.
-If an incoming request to the Zeppelin server does not have a cookie with user information encrypted with the authentication server public key, the user
-is redirected to the authentication server. Once the user is verified, the authentication server redirects the browser to a specific URL in the Zeppelin server which sets the authentication cookie in the browser.
-The end result is that all requests to the Zeppelin web server have the authentication cookie which contains user and groups information.
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/security/datasource_authorization.md
----------------------------------------------------------------------
diff --git a/docs/security/datasource_authorization.md b/docs/security/datasource_authorization.md
deleted file mode 100644
index 03165c8..0000000
--- a/docs/security/datasource_authorization.md
+++ /dev/null
@@ -1,64 +0,0 @@
----
-layout: page
-title: "Data Source Authorization in Apache Zeppelin"
-description: "Apache Zeppelin supports protected data sources. In case of a MySql database, every users can set up their own credentials to access it."
-group: security
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Data Source Authorization in Apache Zeppelin
-
-<div id="toc"></div>
-
-## Overview
-
-Data source authorization involves authenticating to the data source like a Mysql database and letting it determine user permissions.
-Apache Zeppelin allows users to use their own credentials to authenticate with **Data Sources**.
-
-For example, let's assume you have an account in the Vertica databases with credentials.
-You might want to use this account to create a JDBC connection instead of a shared account with all users who are defined in `conf/shiro.ini`.
-In this case, you can add your credential information to Apache Zeppelin and use them with below simple steps.
-
-## How to save the credential information?
-You can add new credentials in the dropdown menu for your data source which can be passed to interpreters.
-
-<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/credential_tab.png" width="180px"/>
-
-**Entity** can be the key that distinguishes each credential sets.(We suggest that the convention of the **Entity** is `[Interpreter Group].[Interpreter Name]`.)
-Please see [what is interpreter group](../manual/interpreters.html#what-is-interpreter-group) for the detailed information.
-
-Type **Username & Password** for your own credentials. ex) Mysql user & password of the JDBC Interpreter.
-
-<img class="img-responsive" src="../assets/themes/zeppelin/img/docs-img/add_credential.png" />
-
-The credentials saved as per users defined in `conf/shiro.ini`.
-If you didn't activate [shiro authentication in Apache Zeppelin](./shiroauthentication.html), your credential information will be saved as `anonymous`.
-All credential information also can be found in `conf/credentials.json`.
-
-#### JDBC interpreter
-You need to maintain per-user connection pools.
-The interpret method takes the user string as a parameter and executes the jdbc call using a connection in the user's connection pool.
-
-#### Presto
-You don't need a password if the Presto DB server runs backend code using HDFS authorization for the user.
-
-#### Vertica and Mysql
-You have to store the password information for users.
-
-## Please note
-As a first step of data source authentication feature, [ZEPPELIN-828](https://issues.apache.org/jira/browse/ZEPPELIN-828) was proposed and implemented in Pull Request [#860](https://github.com/apache/zeppelin/pull/860).
-Currently, only customized 3rd party interpreters can use this feature. We are planning to apply this mechanism to [the community managed interpreters](../manual/interpreterinstallation.html#available-community-managed-interpreters) in the near future.
-Please keep track [ZEPPELIN-1070](https://issues.apache.org/jira/browse/ZEPPELIN-1070).
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/security/helium_authorization.md
----------------------------------------------------------------------
diff --git a/docs/security/helium_authorization.md b/docs/security/helium_authorization.md
deleted file mode 100644
index fdfb435..0000000
--- a/docs/security/helium_authorization.md
+++ /dev/null
@@ -1,28 +0,0 @@
----
-layout: page
-title: "Helium Authorization in Apache Zeppelin"
-description: "Apache Zeppelin supports Helium plugins which fetch required installer packages from remote registry/repositories"
-group: security
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Helium Authorization in Apache Zeppelin
-
-<div id="toc"></div>
-
-## How to configure proxies?
-
-Set **http_proxy** and **https_proxy** env variables to allow connection to npm registry behind a corporate firewall.
\ No newline at end of file
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/4b6d3e55/docs/security/notebook_authorization.md
----------------------------------------------------------------------
diff --git a/docs/security/notebook_authorization.md b/docs/security/notebook_authorization.md
deleted file mode 100644
index a227854..0000000
--- a/docs/security/notebook_authorization.md
+++ /dev/null
@@ -1,79 +0,0 @@
----
-layout: page
-title: "Notebook Authorization in Apache Zeppelin"
-description: "This page will guide you how you can set the permission for Zeppelin notebooks. This document assumes that Apache Shiro authentication was set up."
-group: security
----
-<!--
-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.
--->
-{% include JB/setup %}
-
-# Zeppelin Notebook Authorization
-
-<div id="toc"></div>
-
-## Overview
-We assume that there is an **Shiro Authentication** component that associates a user string and a set of group strings with every NotebookSocket.
-If you don't set the authentication components yet, please check [Shiro authentication for Apache Zeppelin](./shiroauthentication.html) first.
-
-## Authorization Setting
-You can set Zeppelin notebook permissions in each notebooks. Of course only **notebook owners** can change this configuration.
-Just click **Lock icon** and open the permission setting page in your notebook.
-
-As you can see, each Zeppelin notebooks has 3 entities :
-
-* Owners ( users or groups )
-* Readers ( users or groups )
-* Writers ( users or groups )
-
-<center><img src="../assets/themes/zeppelin/img/docs-img/permission_setting.png"></center>
-
-Fill out the each forms with comma seperated **users** and **groups** configured in `conf/shiro.ini` file.
-If the form is empty (*), it means that any users can perform that operation.
-
-If someone who doesn't have **read** permission is trying to access the notebook or someone who doesn't have **write** permission is trying to edit the notebook, Zeppelin will ask to login or block the user.
-
-<center><img src="../assets/themes/zeppelin/img/docs-img/insufficient_privileges.png"></center>
-
-## Separate notebook workspaces (public vs. private)
-By default, the authorization rights allow other users to see the newly created note, meaning the workspace is `public`. This behavior is controllable and can be set through either `ZEPPELIN_NOTEBOOK_PUBLIC` variable in `conf/zeppelin-env.sh`, or through `zeppelin.notebook.public` property in `conf/zeppelin-site.xml`. Thus, in order to make newly created note appear only in your `private` workspace by default, you can set either `ZEPPELIN_NOTEBOOK_PUBLIC` to `false` in your `conf/zeppelin-env.sh` as follows:
-
-```
-export ZEPPELIN_NOTEBOOK_PUBLIC="false"
-```
-
-or set `zeppelin.notebook.public` property to `false` in `conf/zeppelin-site.xml` as follows:
-
-```
-<property>
- <name>zeppelin.notebook.public</name>
- <value>false</value>
- <description>Make notebook public by default when created, private otherwise</description>
-</property>
-```
-
-Behind the scenes, when you create a new note only the `owners` field is filled with current user, leaving `readers` and `writers` fields empty. All the notes with at least one empty authorization field are considered to be in `public` workspace. Thus when setting `zeppelin.notebook.public` (or corresponding `ZEPPELIN_NOTEBOOK_PUBLIC`) to false, newly created notes have `readers` and `writers` fields filled with current user, making note appear as in `private` workspace.
-
-## How it works
-In this section, we will explain the detail about how the notebook authorization works in backend side.
-
-### NotebookServer
-The [NotebookServer](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/socket/NotebookServer.java) classifies every notebook operations into three categories: **Read**, **Write**, **Manage**.
-Before executing a notebook operation, it checks if the user and the groups associated with the `NotebookSocket` have permissions.
-For example, before executing a **Read** operation, it checks if the user and the groups have at least one entity that belongs to the **Reader** entities.
-
-### Notebook REST API call
-Zeppelin executes a [REST API call](https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/NotebookRestApi.java) for the notebook permission information.
-In the backend side, Zeppelin gets the user information for the connection and allows the operation if the users and groups
-associated with the current user have at least one entity that belongs to owner entities for the notebook.