Repository: incubator-griffin Updated Branches: refs/heads/master d6b4abb9f -> 400965077
update api guide fix the problem of document format error Author: EdwardHoot <[email protected]> Closes #278 from EdwardHoot/master. Project: http://git-wip-us.apache.org/repos/asf/incubator-griffin/repo Commit: http://git-wip-us.apache.org/repos/asf/incubator-griffin/commit/40096507 Tree: http://git-wip-us.apache.org/repos/asf/incubator-griffin/tree/40096507 Diff: http://git-wip-us.apache.org/repos/asf/incubator-griffin/diff/40096507 Branch: refs/heads/master Commit: 400965077be86237be1a6c38e8eec9286c0adf35 Parents: d6b4abb Author: EdwardHoot <[email protected]> Authored: Thu May 10 18:38:17 2018 +0800 Committer: Lionel Liu <[email protected]> Committed: Thu May 10 18:38:17 2018 +0800 ---------------------------------------------------------------------- griffin-doc/service/api-guide.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) ---------------------------------------------------------------------- http://git-wip-us.apache.org/repos/asf/incubator-griffin/blob/40096507/griffin-doc/service/api-guide.md ---------------------------------------------------------------------- diff --git a/griffin-doc/service/api-guide.md b/griffin-doc/service/api-guide.md index 2a95f06..bd5de67 100644 --- a/griffin-doc/service/api-guide.md +++ b/griffin-doc/service/api-guide.md @@ -39,6 +39,7 @@ Apache Griffin default `BASE_PATH` is `http://<your ip>:8080`. <h2 id = "0"></h2> + ## HTTP Response Desigin ### Normal Response The normal HTTP response is designed as follow: @@ -88,6 +89,7 @@ Description: Note that 'exception' field may not exist if it is caused by client error, and 'code' field may not exist for server error. <h2 id = "1"></h2> + ## Griffin Basic ### Get griffin version @@ -97,9 +99,11 @@ Note that 'exception' field may not exist if it is caused by client error, and ' `0.1.0` <h2 id = "2"></h2> + ## Measures ### Add measure + `POST /api/v1/measures` #### Request Header @@ -637,9 +641,13 @@ The response body should be empty if no error happens, and the HTTP status is (2 ``` <h2 id = "3"></h2> + ## Jobs + ### Add job + `POST /api/v1/jobs` + #### Request Header | key | value | | ------------ | ---------------- | @@ -876,9 +884,13 @@ maximum record count is 100. ``` <h2 id = "4"></h2> + ## Metrics + ### Get metrics + `GET /api/v1/metrics` + #### Response Example The response is a map of metrics group by measure name. For example: ``` @@ -1048,9 +1060,13 @@ The response body should have 'failures' field as empty if success, for example ``` <h2 id = "5"></h2> + ### Hive MetaStore + ### Get table metadata + `GET /api/v1/metadata/hive/table` + #### Request Parameters | name | description | type | example value | | ----- | ------------------ | ------ | ------------- | @@ -1382,7 +1398,9 @@ The response body should have 'failures' field as empty if success, for example <h2 id = "6"></h2> + ## Auth + ### User authentication `POST /api/v1/login/authenticate`
