mirror of
https://github.com/apache/zeppelin
synced 2026-05-24 09:38:26 +00:00
Apply auto TOC to all of docs under docs/rest-api/
This commit is contained in:
AhyoungRyu
parent
163691ce51
commit
b05365f7a7
3 changed files with 59 additions and 66 deletions
|
|
@ -19,18 +19,22 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
## Zeppelin REST API
|
||||
Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
|
||||
# Apache Zeppelin Configuration REST API
|
||||
|
||||
All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. Note that 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).
|
||||
<div id="toc"></div>
|
||||
|
||||
If you work with Zeppelin and find a need for an additional REST API, please [file an issue or send us mail](../../community.html).
|
||||
## 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).
|
||||
nd a need for an additional REST API, please [file an issue or send us mail](../../community.html).
|
||||
|
||||
<br />
|
||||
|
||||
## Configuration REST API list
|
||||
|
||||
### List Configurations
|
||||
### List all key/value pair of configurations
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -89,7 +93,7 @@ limitations under the License.
|
|||
|
||||
<br/>
|
||||
|
||||
### List Configurations(prefix match)
|
||||
### List all prefix matched key/value pair of configurations
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -128,3 +132,4 @@ limitations under the License.
|
|||
</td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -19,19 +19,22 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
## Zeppelin REST API
|
||||
Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
|
||||
# Apache Zeppelin Interpreter REST API
|
||||
|
||||
All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. Note that 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).
|
||||
<div id="toc"></div>
|
||||
|
||||
If you work with Zeppelin and find a need for an additional REST API, please [file an issue or send us mail](http://zeppelin.apache.org/community.html).
|
||||
## 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).
|
||||
|
||||
<br />
|
||||
## Interpreter REST API List
|
||||
|
||||
The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
|
||||
The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
|
||||
|
||||
### List of Registered Interpreters
|
||||
### List of registered interpreters
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -102,8 +105,8 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
### List of registered interpreter settings
|
||||
|
||||
### List of Interpreter Settings
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -177,7 +180,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
### Create an Interpreter Setting
|
||||
### Create a new interpreter setting
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -256,10 +259,8 @@ limitations under the License.
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<br/>
|
||||
|
||||
### Update an Interpreter Setting
|
||||
### Update an interpreter setting
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -337,9 +338,8 @@ limitations under the License.
|
|||
</tr>
|
||||
</table>
|
||||
|
||||
|
||||
<br/>
|
||||
### Delete an Interpreter Setting
|
||||
### Delete an interpreter setting
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -369,7 +369,7 @@ limitations under the License.
|
|||
|
||||
|
||||
<br/>
|
||||
### Restart an Interpreter
|
||||
### Restart an interpreter
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -398,7 +398,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
### Add repository for dependency resolving
|
||||
### Add a new repository for dependency resolving
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -439,7 +439,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
### Delete repository for dependency resolving
|
||||
### Delete a repository for dependency resolving
|
||||
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -460,3 +460,4 @@ limitations under the License.
|
|||
<td> 500 </td>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
|
|
@ -19,20 +19,23 @@ limitations under the License.
|
|||
-->
|
||||
{% include JB/setup %}
|
||||
|
||||
## Zeppelin REST API
|
||||
Zeppelin provides several REST APIs for interaction and remote activation of zeppelin functionality.
|
||||
# Apache Zeppelin Notebook REST API
|
||||
|
||||
All REST APIs are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`. Note that 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).
|
||||
<div id="toc"></div>
|
||||
|
||||
If you work with Zeppelin and find a need for an additional REST API, please [file an issue or send us mail](../../community.html).
|
||||
## 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).
|
||||
|
||||
<br />
|
||||
|
||||
## 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.
|
||||
|
||||
### List Notebooks
|
||||
### List of the notebooks
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -74,8 +77,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Create Notebook
|
||||
### Create a new notebook
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -129,8 +131,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Get Notebook
|
||||
### Get an existing notebook information
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -227,8 +228,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Delete Notebook
|
||||
### Delete a notebook
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -255,8 +255,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Clone Notebook
|
||||
### Clone a notebook
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -294,13 +293,12 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Run Notebook Job
|
||||
### Run all paragraphs
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
<td>Description</td>
|
||||
<td>This ```POST``` method runs all paragraph in the given notebook id.
|
||||
<td>This ```POST``` method runs all paragraphs in the given notebook id.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -322,13 +320,12 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Stop Notebook Job
|
||||
### Stop all paragraphs
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
<td>Description</td>
|
||||
<td>This ```DELETE``` method stops all paragraph in the given notebook id.
|
||||
<td>This ```DELETE``` method stops all paragraphs in the given notebook id.
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -350,13 +347,12 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Get Notebook Job
|
||||
### Get the status of all paragraphs
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
<td>Description</td>
|
||||
<td>This ```GET``` method gets all paragraph status by the given notebook id.
|
||||
<td>This ```GET``` method gets the status of all paragraphs by the given notebook id.
|
||||
The body field of the returned JSON contains of the array that compose of the paragraph id, paragraph status, paragraph finish date, paragraph started date.
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -397,8 +393,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Run Paragraph Job
|
||||
### Run a paragraph
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -436,8 +431,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Stop Paragraph Job
|
||||
### Stop a paragraph
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -464,7 +458,6 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Add Cron Job
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
|
|
@ -553,8 +546,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br />
|
||||
|
||||
### Full Text Search Through the Paragraphs in All Notebooks
|
||||
### Full text search through the paragraphs in all notebooks
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -592,8 +584,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Create Paragraph
|
||||
### Create a new paragraph
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -643,8 +634,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Get Paragraph
|
||||
### Get a paragraph information
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -712,8 +702,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br/>
|
||||
|
||||
### Move Paragraph
|
||||
### Move a paragraph to the specific index
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -741,8 +730,7 @@ limitations under the License.
|
|||
|
||||
|
||||
<br/>
|
||||
|
||||
### Delete Paragraph
|
||||
### Delete a paragraph
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -769,8 +757,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br />
|
||||
|
||||
### Export Notebook
|
||||
### Export a notebook
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -820,8 +807,7 @@ limitations under the License.
|
|||
</table>
|
||||
|
||||
<br />
|
||||
|
||||
### Import Notebook
|
||||
### Import a notebook
|
||||
<table class="table-configuration">
|
||||
<col width="200">
|
||||
<tr>
|
||||
|
|
@ -879,3 +865,4 @@ limitations under the License.
|
|||
</tr>
|
||||
</tr>
|
||||
</table>
|
||||
|
||||
Loading…
Reference in a new issue