You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@zeppelin.apache.org by mo...@apache.org on 2015/12/21 01:32:14 UTC
incubator-zeppelin git commit: [Improve] Add interpreter restart REST
API doc
Repository: incubator-zeppelin
Updated Branches:
refs/heads/master f54b49b40 -> be8a74729
[Improve] Add interpreter restart REST API doc
### What is this PR for?
Add restarting interpreter REST API information to the document.
There is no information in the document even though REST API exist.
### What type of PR is it?
Documentation
### Todos
* [x] - add restart REST API document.
### Is there a relevant Jira issue?
https://issues.apache.org/jira/browse/ZEPPELIN-521
### How should this be tested?
You can get the test information from https://github.com/apache/incubator-zeppelin/tree/master/docs.
### Questions:
* Does the licenses files need update? no
* Is there breaking changes for older versions? no
* Does this needs documentation? no
Author: astroshim <hs...@nflabs.com>
Closes #555 from astroshim/ZEPPELIN-521 and squashes the following commits:
a7ebcf3 [astroshim] to fix build fail.
b9cb440 [astroshim] add interpreter restart REST API doc
Project: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/commit/be8a7472
Tree: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/tree/be8a7472
Diff: http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/diff/be8a7472
Branch: refs/heads/master
Commit: be8a7472908ba1b26ca0bbaafa89a55c1599a258
Parents: f54b49b
Author: astroshim <hs...@nflabs.com>
Authored: Fri Dec 18 20:53:50 2015 -0800
Committer: Lee moon soo <mo...@apache.org>
Committed: Mon Dec 21 09:33:39 2015 +0900
----------------------------------------------------------------------
docs/rest-api/rest-interpreter.md | 34 ++++++++++++++++++++++++++++++++++
1 file changed, 34 insertions(+)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/incubator-zeppelin/blob/be8a7472/docs/rest-api/rest-interpreter.md
----------------------------------------------------------------------
diff --git a/docs/rest-api/rest-interpreter.md b/docs/rest-api/rest-interpreter.md
index d852340..6e41fe8 100644
--- a/docs/rest-api/rest-interpreter.md
+++ b/docs/rest-api/rest-interpreter.md
@@ -361,3 +361,37 @@ limitations under the License.
</td>
</tr>
</table>
+
+
+<br/>
+
+ <table class="table-configuration">
+ <col width="200">
+ <tr>
+ <th>Restart an interpreter</th>
+ <th></th>
+ </tr>
+ <tr>
+ <td>Description</td>
+ <td>This ```PUT``` method restart 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 response
+ </td>
+ <td>
+ <pre>{"status":"OK"}</pre>
+ </td>
+ </tr>
+ </table>