Search: adding search API docs

This commit is contained in:
Alexander Bezzubov 2015-12-11 16:41:10 +09:00
parent 98f4e59051
commit 63a4e057bb

View file

@ -424,4 +424,33 @@ limitations under the License.
<td><pre>{"status":"OK","body":"* * * * * ?"}</pre></td>
</tr>
</table>
<table class="table-configuration">
<col width="200">
<tr>
<th>Full-text search thoug the paragraps in all notebooks</th>
<th></th>
</tr>
<tr>
<td>Description</td>
<td>```GET``` request will return list of matching paragraphs
</td>
</tr>
<tr>
<td>URL</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>Fail code</td>
<td> 500 </td>
</tr>
<tr>
<td>Sample JSON response </td>
<td><pre>{"status":"OK", body: [{"id":"<noteId>/paragraph/<paragraphId>", "name":"Notebook Name", "snippet":"", "text":""}]}</pre></td>
</tr>
</table>