Elgato_dark/zeppelin
1
0
Fork 0
mirror of https://github.com/apache/zeppelin synced 2026-05-24 09:38:26 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1

Add numbering for dividing the table list and Fix grammar error rest-interpreter.md

Browse source
This commit is contained in:
Ryu Ah young 2016-01-01 20:05:37 -08:00
parent fe4dfff473
commit f3d01730db
1 changed files with 35 additions and 38 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

73
docs/rest-api/rest-interpreter.md
View file

@ -22,28 +22,29 @@ limitations under the License.
## Zeppelin REST API
Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality.
All REST API are available starting with the following endpoint ```http://[zeppelin-server]:[zeppelin-port]/api```
All REST API are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON view such as
[JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc)
[JSON View](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
If you work with zeppelin and find a need for an additional REST API please [file an issue or send us mail](../../community.html)
If you work with zeppelin and find a need for an additional REST API, please [file an issue or send us mail](http://zeppelin.incubator.apache.org/community.html).
<br />
### Interpreter REST API list
## Interpreter REST API List
The role of registered interpreters, settings and interpreters group is described [here](../manual/interpreters.html)
The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
### 1. List of Registered Interpreters & Interpreter Settings
<table class="table-configuration">
<col width="200">
<tr>
<th>List registered interpreters</th>
<th>List of registered interpreters</th>
<th></th>
</tr>
<tr>
<td>Description</td>
<td>This ```GET``` method return all the registered interpreters available on the server.</td>
<td>This ```GET``` method returns all the registered interpreters available on the server.</td>
</tr>
<tr>
<td>URL</td>
@ -54,12 +55,11 @@ limitations under the License.
<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 response</td>
<td>
<pre>
{
@ -113,12 +113,12 @@ limitations under the License.
<table class="table-configuration">
<col width="200">
<tr>
<th>List interpreters settings</th>
<th>List of interpreters settings</th>
<th></th>
</tr>
<tr>
<td>Description</td>
<td>This ```GET``` method return all the interpreters settings registered on the server.</td>
<td>This ```GET``` method returns all the interpreters settings registered on the server.</td>
</tr>
<tr>
<td>URL</td>
@ -129,12 +129,11 @@ limitations under the License.
<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 response</td>
<td>
<pre>
{
@ -182,7 +181,8 @@ limitations under the License.
</table>
<br/>
### 2. Create an Interpreter Setting
<table class="table-configuration">
<col width="200">
<tr>
@ -202,12 +202,11 @@ limitations under the License.
<td>201</td>
</tr>
<tr>
<td> Fail code</td>
<td>Fail code</td>
<td> 500 </td>
</tr>
<tr>
<td> sample JSON input
</td>
<td>Sample JSON input</td>
<td>
<pre>
{
@ -227,8 +226,7 @@ limitations under the License.
</td>
</tr>
<tr>
<td> sample JSON response
</td>
<td>Sample JSON response</td>
<td>
<pre>
{
@ -256,7 +254,8 @@ limitations under the License.
<br/>
### 3. Update an Interpreter Setting
<table class="table-configuration">
<col width="200">
<tr>
@ -276,12 +275,11 @@ limitations under the License.
<td>200</td>
</tr>
<tr>
<td> Fail code</td>
<td>Fail code</td>
<td> 500 </td>
</tr>
<tr>
<td> sample JSON input
</td>
<td>Sample JSON input</td>
<td>
<pre>
{
@ -301,8 +299,7 @@ limitations under the License.
</td>
</tr>
<tr>
<td> sample JSON response
</td>
<td>Sample JSON response</td>
<td>
<pre>
{
@ -330,7 +327,8 @@ limitations under the License.
<br/>
### 4. Delete an Interpreter Setting
<table class="table-configuration">
<col width="200">
<tr>
@ -354,17 +352,17 @@ limitations under the License.
<td> 500 </td>
</tr>
<tr>
<td> sample JSON response
</td>
<td>Sample JSON response</td>
<td>
<pre>{"status":"OK"}</pre>
<code>{"status":"OK"}</code>
</td>
</tr>
</table>
<br/>
### 5. Restart an Interpreter
<table class="table-configuration">
<col width="200">
<tr>
@ -373,7 +371,7 @@ limitations under the License.
</tr>
<tr>
<td>Description</td>
<td>This ```PUT``` method restart the given interpreter id.</td>
<td>This ```PUT``` method restarts the given interpreter id.</td>
</tr>
<tr>
<td>URL</td>
@ -384,14 +382,13 @@ limitations under the License.
<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 response</td>
<td>
<pre>{"status":"OK"}</pre>
<code>{"status":"OK"}</code>
</td>
</tr>
</table>