You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by ah...@apache.org on 2017/01/11 02:20:58 UTC
zeppelin git commit: [DOCS][ZEPPELIN-1586] Add 'Security' section
under notebook restapi docs
Repository: zeppelin
Updated Branches:
refs/heads/master 99946e719 -> 481eabb2a
[DOCS][ZEPPELIN-1586] Add 'Security' section under notebook restapi docs
### What is this PR for?
After #1567 merged we can get/set note permission info for a certain note. But this info is not described in anywhere for now. So I added "Security" section under [docs/rest-api/rest-notebook.md](https://github.com/apache/zeppelin/blob/master/docs/rest-api/rest-notebook.md).
And currently so many operations are placed under one section like below.
<img src="https://cloud.githubusercontent.com/assets/10060731/21560964/c55d41cc-cea9-11e6-96ac-68f762c68bff.png" width="400px">
So I split them under each `Note opersions`, `Paragraph operations`, `Cron jobs`, and `Permission` section.
<img src="https://cloud.githubusercontent.com/assets/10060731/21799253/ca3bc596-d75b-11e6-82e5-ba440c7f0713.png" width="400px">
### What type of PR is it?
Documentation
### What is the Jira issue?
[ZEPPELIN-1877](https://issues.apache.org/jira/browse/ZEPPELIN-1877)
### How should this be tested?
Please see the below screenshots :)
### Screenshots (if appropriate)
### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no
Author: AhyoungRyu <fb...@hanmail.net>
Closes #1825 from AhyoungRyu/ZEPPELIN-1586/docs and squashes the following commits:
a8b6506 [AhyoungRyu] Change some operations' ordering based on CRUD
09d22d3 [AhyoungRyu] Add 'Security' section under notebook restapi docs
Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/481eabb2
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/481eabb2
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/481eabb2
Branch: refs/heads/master
Commit: 481eabb2ab5545ca4d51975bef2162b16229d676
Parents: 99946e7
Author: AhyoungRyu <fb...@hanmail.net>
Authored: Tue Jan 10 17:39:06 2017 +0900
Committer: ahyoungryu <ah...@apache.org>
Committed: Wed Jan 11 11:20:49 2017 +0900
----------------------------------------------------------------------
docs/rest-api/rest-notebook.md | 916 ++++++++++++++++++++----------------
1 file changed, 509 insertions(+), 407 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/zeppelin/blob/481eabb2/docs/rest-api/rest-notebook.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-notebook.md b/docs/rest-api/rest-notebook.md
index 7f6f5b4..df0afa5 100644
--- a/docs/rest-api/rest-notebook.md
+++ b/docs/rest-api/rest-notebook.md
@@ -27,14 +27,11 @@ limitations under the License.
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.
-## Notebook REST API List
-
- 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">
@@ -131,6 +128,52 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</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">
@@ -296,7 +339,117 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</tr>
</table>
-<br/>
+<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">
@@ -370,101 +523,107 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</tr>
</table>
-<br/>
-### Get the status of all paragraphs
+<br />
+### Clear all paragraph result
<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>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/job/[noteId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/clear```</td>
</tr>
<tr>
<td>Success code</td>
<td>200</td>
</tr>
<tr>
- <td> Fail code</td>
- <td> 500 </td>
+ <td>Forbidden code</td>
+ <td>401</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>
+ <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/>
-### Get the status of a single paragraph
+### Create a new 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>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/job/[noteId]/[paragraphId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph```</td>
</tr>
<tr>
<td>Success code</td>
- <td>200</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": "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"
- }
+ "status": "CREATED",
+ "message": "",
+ "body": "20151218-100330\_1754029574"
}</pre></td>
</tr>
</table>
<br/>
-### Run a paragraph asynchronously
+### Get a paragraph information
<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>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/job/[noteId]/[paragraphId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -475,34 +634,68 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
<td> 500 </td>
</tr>
<tr>
- <td> sample JSON input (optional, only needed when if you want to update dynamic form's value) </td>
+ <td> sample JSON response </td>
<td><pre>
{
- "name": "name of new note",
- "params": {
- "formLabel1": "value1",
- "formLabel2": "value2"
+ "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>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
</table>
<br/>
-### Run a paragraph synchronously
+### Get the status of a single paragraph
<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>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/run/[noteId]/[paragraphId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -513,105 +706,157 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
<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"
- }
+ "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/>
-### Stop a paragraph
+### Update paragraph configuration
<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>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/job/[noteId]/[paragraphId]```</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> Fail code</td>
- <td> 500 </td>
- </tr>
- <tr>
- <td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
- </tr>
- </table>
-
-<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>
+ <td>Bad Request code</td>
+ <td>400</td>
</tr>
<tr>
- <td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</td>
+ <td>Forbidden code</td>
+ <td>403</td>
</tr>
<tr>
- <td>Success code</td>
- <td>200</td>
+ <td>Not Found code</td>
+ <td>404</td>
</tr>
<tr>
- <td> Fail code</td>
- <td> 500 </td>
+ <td>Fail code</td>
+ <td>500</td>
</tr>
<tr>
- <td> sample JSON input </td>
- <td><pre>{"cron": "cron expression of note"}</pre></td>
+ <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"}</pre></td>
+ <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/>
-
-### Remove Cron Job
+### Delete a paragraph
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>This ```DELETE``` method removes cron job by the given note id.
+ <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/cron/[noteId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -623,24 +868,22 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</tr>
<tr>
<td> sample JSON response </td>
- <td><pre>{"status": "OK"}</pre></td>
+ <td><pre>{"status": "OK","message": ""}</pre></td>
</tr>
</table>
<br/>
-
-### Get Cron Job
+### Run a paragraph asynchronously
<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>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/cron/[noteId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -651,112 +894,111 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
<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", "body": "* * * * * ?"}</pre></td>
+ <td><pre>{"status": "OK"}</pre></td>
</tr>
</table>
-<br />
-### Full text search through the paragraphs in all notes
+<br/>
+### Run a paragraph synchronously
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>```GET``` request will return list of matching paragraphs
+ <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/search?q=[query]```</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> Fail code</td>
<td> 500 </td>
</tr>
<tr>
- <td>Sample JSON response </td>
+ <td> sample JSON input (optional, only needed when if you want to update dynamic form's value) </td>
<td><pre>
{
- "status": "OK",
- "body": [
- {
- "id": "<noteId>/paragraph/<paragraphId>",
- "name":"Note Name",
- "snippet":"",
- "text":""
- }
- ]
+ "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/>
-### Create a new paragraph
+### Stop a 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>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/[noteId]/paragraph```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/job/[noteId]/[paragraphId]```</td>
</tr>
<tr>
<td>Success code</td>
- <td>201</td>
+ <td>200</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>
+ <td><pre>{"status": "OK"}</pre></td>
</tr>
</table>
<br/>
-### Get a paragraph information
+### Move a paragraph to the specific index
<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>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]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/move/[newIndex]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -768,191 +1010,61 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</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>
+ <td><pre>{"status": "OK","message": ""}</pre></td>
</tr>
</table>
-
-<br/>
-### Update paragraph configuration
+
+<br />
+### Full text search through the paragraphs in all notes
<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>```GET``` request will return list of matching paragraphs
</td>
</tr>
<tr>
<td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/paragraph/[paragraphId]/config```</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>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>
+ <td> 500 </td>
</tr>
<tr>
- <td>sample JSON response</td>
+ <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
- }
+ "status": "OK",
+ "body": [
+ {
+ "id": "<noteId>/paragraph/<paragraphId>",
+ "name":"Note Name",
+ "snippet":"",
+ "text":""
+ }
+ ]
}</pre></td>
</tr>
</table>
+## Cron jobs
<br/>
-### Move a paragraph to the specific index
+### Add Cron Job
<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>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/[noteId]/paragraph/[paragraphId]/move/[newIndex]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -963,23 +1075,28 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
<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","message": ""}</pre></td>
+ <td><pre>{"status": "OK"}</pre></td>
</tr>
</table>
<br/>
-### Delete a paragraph
+
+### Remove Cron Job
<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>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/[noteId]/paragraph/[paragraphId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</td>
</tr>
<tr>
<td>Success code</td>
@@ -991,133 +1108,102 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</tr>
<tr>
<td> sample JSON response </td>
- <td><pre>{"status": "OK","message": ""}</pre></td>
+ <td><pre>{"status": "OK"}</pre></td>
</tr>
</table>
-<br />
-### Export a note
+<br/>
+
+### Get Cron Job
<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>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/export/[noteId]```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/cron/[noteId]```</td>
</tr>
<tr>
<td>Success code</td>
- <td>201</td>
+ <td>200</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>
+ <td> sample JSON response </td>
+ <td><pre>{"status": "OK", "body": "* * * * * ?"}</pre></td>
</tr>
</table>
-<br />
-### Import a note
+## Permission
+
+
+
+### Get a note permission information
+
<table class="table-configuration">
<col width="200">
<tr>
<td>Description</td>
- <td>This ```POST``` method imports a note from the note JSON input
+ <td>This ```GET``` method gets a note authorization information.
</td>
</tr>
<tr>
<td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/import```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions```</td>
</tr>
<tr>
<td>Success code</td>
- <td>201</td>
+ <td>200</td>
</tr>
<tr>
- <td> Fail code</td>
- <td> 500 </td>
+ <td>Forbidden code</td>
+ <td>403</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>
+ <td>Fail code</td>
+ <td>500</td>
</tr>
<tr>
- <td>sample JSON response</td>
+ <td> sample JSON response </td>
<td><pre>
-{
- "status": "CREATED",
- "message": "",
- "body": "2AZPHY918"
-}</pre></td>
+{
+ "status":"OK",
+ "message":"",
+ "body":{
+ "readers":[
+ "user2"
+ ],
+ "owners":[
+ "user1"
+ ],
+ "writers":[
+ "user2"
+ ]
+ }
+}
+ </pre></td>
</tr>
</table>
-<br />
-### Clear all paragraph result
+<br/>
+### Set note permission
<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>This ```PUT``` method set note authorization information.
</td>
</tr>
<tr>
<td>URL</td>
- <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/clear```</td>
+ <td>```http://[zeppelin-server]:[zeppelin-port]/api/notebook/[noteId]/permissions```</td>
</tr>
<tr>
<td>Success code</td>
@@ -1125,19 +1211,35 @@ If you work with Apache Zeppelin and find a need for an additional REST API, ple
</tr>
<tr>
<td>Forbidden code</td>
- <td>401</td>
- </tr>
- <tr>
- <td>Not Found code</td>
- <td>404</td>
+ <td>403</td>
</tr>
<tr>
<td>Fail code</td>
<td>500</td>
</tr>
<tr>
- <td>sample JSON response</td>
- <td><pre>{"status": "OK"}</pre></td>
+ <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>
+
+