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 2018/11/16 19:59:29 UTC

zeppelin git commit: docs [master]: REST API JSON response status fix

Repository: zeppelin
Updated Branches:
  refs/heads/master a7f3f3c55 -> b31f2998e


docs [master]: REST API JSON response status fix

### What is this PR for?
Since v0.8.0, REST API JSON response `status` attribute has changed from `CREATED` to `OK`.

Related source code:
* https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/NotebookRestApi.java
* https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/main/java/org/apache/zeppelin/rest/InterpreterRestApi.java

### What type of PR is it?
Documentation

### Questions:
* Shall I add tests to check the returned `status` in:
   * https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/test/java/org/apache/zeppelin/rest/InterpreterRestApiTest.java
   * https://github.com/apache/zeppelin/blob/master/zeppelin-server/src/test/java/org/apache/zeppelin/rest/NotebookRestApiTest.java

Author: John Lau <jo...@outlook.com>

Closes #3224 from jolks/doc_rest_api_fix and squashes the following commits:

9037b55c6 [John Lau] REST API JSON response status fix


Project: http://git-wip-us.apache.org/repos/asf/zeppelin/repo
Commit: http://git-wip-us.apache.org/repos/asf/zeppelin/commit/b31f2998
Tree: http://git-wip-us.apache.org/repos/asf/zeppelin/tree/b31f2998
Diff: http://git-wip-us.apache.org/repos/asf/zeppelin/diff/b31f2998

Branch: refs/heads/master
Commit: b31f2998ef6eed49f053c90b36adaa6a8338d982
Parents: a7f3f3c
Author: John Lau <jo...@outlook.com>
Authored: Tue Nov 13 18:04:08 2018 +0900
Committer: Lee moon soo <mo...@apache.org>
Committed: Sat Nov 17 04:59:25 2018 +0900

----------------------------------------------------------------------
 docs/usage/rest_api/interpreter.md | 2 +-
 docs/usage/rest_api/notebook.md    | 8 ++++----
 2 files changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/zeppelin/blob/b31f2998/docs/usage/rest_api/interpreter.md
----------------------------------------------------------------------
diff --git a/docs/usage/rest_api/interpreter.md b/docs/usage/rest_api/interpreter.md
index 23a7c66..c750289 100644
--- a/docs/usage/rest_api/interpreter.md
+++ b/docs/usage/rest_api/interpreter.md
@@ -315,7 +315,7 @@ The role of registered interpreters, settings and interpreters group are describ
       <td>
         <pre>
 {
-  "status": "CREATED",
+  "status": "OK",
   "message": "",
   "body": {
     "id": "2AYW25ANY",

http://git-wip-us.apache.org/repos/asf/zeppelin/blob/b31f2998/docs/usage/rest_api/notebook.md
----------------------------------------------------------------------
diff --git a/docs/usage/rest_api/notebook.md b/docs/usage/rest_api/notebook.md
index 960847a..4d2b2cf 100644
--- a/docs/usage/rest_api/notebook.md
+++ b/docs/usage/rest_api/notebook.md
@@ -132,7 +132,7 @@ Notebooks REST API supports the following operations: List, Create, Get, Delete,
       <td> sample JSON response </td>
       <td><pre>
 {
-  "status": "CREATED",
+  "status": "OK",
   "message": "",
   "body": "2AZPHY918"
 }</pre></td>
@@ -344,7 +344,7 @@ Notebooks REST API supports the following operations: List, Create, Get, Delete,
       <td> sample JSON response </td>
       <td><pre>
 {
-  "status": "CREATED",
+  "status": "OK",
   "message": "",
   "body": "2AZPHY918"
 }</pre></td>
@@ -491,7 +491,7 @@ Notebooks REST API supports the following operations: List, Create, Get, Delete,
       <td>sample JSON response</td>
       <td><pre>
 {
-  "status": "CREATED",
+  "status": "OK",
   "message": "",
   "body": "2AZPHY918"
 }</pre></td>
@@ -672,7 +672,7 @@ Notebooks REST API supports the following operations: List, Create, Get, Delete,
       <td> sample JSON response </td>
       <td><pre>
 {
-  "status": "CREATED",
+  "status": "OK",
   "message": "",
   "body": "20151218-100330\_1754029574"
 }</pre></td>