Skip to content

Commit f3d0173

Browse files
AhyoungRyuAhyoungRyu
committed
Add numbering for dividing the table list and Fix grammar error rest-interpreter.md
1 parent fe4dfff commit f3d0173

File tree

1 file changed

+35
-38
lines changed

1 file changed

+35
-38
lines changed

‎docs/rest-api/rest-interpreter.md‎

Lines changed: 35 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -22,28 +22,29 @@ limitations under the License.
2222
## Zeppelin REST API
2323
Zeppelin provides several REST API's for interaction and remote activation of zeppelin functionality.
2424

25-
All REST API are available starting with the following endpoint ```http://[zeppelin-server]:[zeppelin-port]/api```
26-
25+
All REST API are available starting with the following endpoint `http://[zeppelin-server]:[zeppelin-port]/api`.
2726
Note that zeppein REST API receive or return JSON objects, it it recommended you install some JSON view such as
28-
[JSONView](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc)
27+
[JSON View](https://chrome.google.com/webstore/detail/jsonview/chklaanhfefbnpoihckbnefhakgolnmc).
2928

3029

31-
If you work with zeppelin and find a need for an additional REST API please [file an issue or send us mail](../../community.html)
30+
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).
3231

3332
<br />
34-
### Interpreter REST API list
33+
## Interpreter REST API List
3534

36-
The role of registered interpreters, settings and interpreters group is described [here](../manual/interpreters.html)
35+
The role of registered interpreters, settings and interpreters group are described in [here](../manual/interpreters.html).
3736

37+
### 1. List of Registered Interpreters & Interpreter Settings
38+
3839
<table class="table-configuration">
3940
<col width="200">
4041
<tr>
41-
<th>List registered interpreters</th>
42+
<th>List of registered interpreters</th>
4243
<th></th>
4344
</tr>
4445
<tr>
4546
<td>Description</td>
46-
<td>This ```GET``` method return all the registered interpreters available on the server.</td>
47+
<td>This ```GET``` method returns all the registered interpreters available on the server.</td>
4748
</tr>
4849
<tr>
4950
<td>URL</td>
@@ -54,12 +55,11 @@ limitations under the License.
5455
<td>200</td>
5556
</tr>
5657
<tr>
57-
<td> Fail code</td>
58+
<td>Fail code</td>
5859
<td> 500 </td>
5960
</tr>
6061
<tr>
61-
<td> sample JSON response
62-
</td>
62+
<td>Sample JSON response</td>
6363
<td>
6464
<pre>
6565
{
@@ -113,12 +113,12 @@ limitations under the License.
113113
<table class="table-configuration">
114114
<col width="200">
115115
<tr>
116-
<th>List interpreters settings</th>
116+
<th>List of interpreters settings</th>
117117
<th></th>
118118
</tr>
119119
<tr>
120120
<td>Description</td>
121-
<td>This ```GET``` method return all the interpreters settings registered on the server.</td>
121+
<td>This ```GET``` method returns all the interpreters settings registered on the server.</td>
122122
</tr>
123123
<tr>
124124
<td>URL</td>
@@ -129,12 +129,11 @@ limitations under the License.
129129
<td>200</td>
130130
</tr>
131131
<tr>
132-
<td> Fail code</td>
132+
<td>Fail code</td>
133133
<td> 500 </td>
134134
</tr>
135135
<tr>
136-
<td> sample JSON response
137-
</td>
136+
<td>Sample JSON response</td>
138137
<td>
139138
<pre>
140139
{
@@ -182,7 +181,8 @@ limitations under the License.
182181
</table>
183182

184183
<br/>
185-
184+
### 2. Create an Interpreter Setting
185+
186186
<table class="table-configuration">
187187
<col width="200">
188188
<tr>
@@ -202,12 +202,11 @@ limitations under the License.
202202
<td>201</td>
203203
</tr>
204204
<tr>
205-
<td> Fail code</td>
205+
<td>Fail code</td>
206206
<td> 500 </td>
207207
</tr>
208208
<tr>
209-
<td> sample JSON input
210-
</td>
209+
<td>Sample JSON input</td>
211210
<td>
212211
<pre>
213212
{
@@ -227,8 +226,7 @@ limitations under the License.
227226
</td>
228227
</tr>
229228
<tr>
230-
<td> sample JSON response
231-
</td>
229+
<td>Sample JSON response</td>
232230
<td>
233231
<pre>
234232
{
@@ -256,7 +254,8 @@ limitations under the License.
256254

257255

258256
<br/>
259-
257+
258+
### 3. Update an Interpreter Setting
260259
<table class="table-configuration">
261260
<col width="200">
262261
<tr>
@@ -276,12 +275,11 @@ limitations under the License.
276275
<td>200</td>
277276
</tr>
278277
<tr>
279-
<td> Fail code</td>
278+
<td>Fail code</td>
280279
<td> 500 </td>
281280
</tr>
282281
<tr>
283-
<td> sample JSON input
284-
</td>
282+
<td>Sample JSON input</td>
285283
<td>
286284
<pre>
287285
{
@@ -301,8 +299,7 @@ limitations under the License.
301299
</td>
302300
</tr>
303301
<tr>
304-
<td> sample JSON response
305-
</td>
302+
<td>Sample JSON response</td>
306303
<td>
307304
<pre>
308305
{
@@ -330,7 +327,8 @@ limitations under the License.
330327

331328

332329
<br/>
333-
330+
### 4. Delete an Interpreter Setting
331+
334332
<table class="table-configuration">
335333
<col width="200">
336334
<tr>
@@ -354,17 +352,17 @@ limitations under the License.
354352
<td> 500 </td>
355353
</tr>
356354
<tr>
357-
<td> sample JSON response
358-
</td>
355+
<td>Sample JSON response</td>
359356
<td>
360-
<pre>{"status":"OK"}</pre>
357+
<code>{"status":"OK"}</code>
361358
</td>
362359
</tr>
363360
</table>
364361

365362

366363
<br/>
367-
364+
### 5. Restart an Interpreter
365+
368366
<table class="table-configuration">
369367
<col width="200">
370368
<tr>
@@ -373,7 +371,7 @@ limitations under the License.
373371
</tr>
374372
<tr>
375373
<td>Description</td>
376-
<td>This ```PUT``` method restart the given interpreter id.</td>
374+
<td>This ```PUT``` method restarts the given interpreter id.</td>
377375
</tr>
378376
<tr>
379377
<td>URL</td>
@@ -384,14 +382,13 @@ limitations under the License.
384382
<td>200</td>
385383
</tr>
386384
<tr>
387-
<td> Fail code</td>
385+
<td>Fail code</td>
388386
<td> 500 </td>
389387
</tr>
390388
<tr>
391-
<td> sample JSON response
392-
</td>
389+
<td>Sample JSON response</td>
393390
<td>
394-
<pre>{"status":"OK"}</pre>
391+
<code>{"status":"OK"}</code>
395392
</td>
396393
</tr>
397394
</table>

0 commit comments

Comments
 (0)