myriad-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From smare...@apache.org
Subject [1/2] incubator-myriad git commit: Added 'destroy api' details to Myriad REST API section
Date Thu, 10 Dec 2015 07:13:04 GMT
Repository: incubator-myriad
Updated Branches:
  refs/heads/master 5b65ed040 -> 06f6ca48d


Added 'destroy api' details to Myriad REST API section

This closes: #50
Review: https://github.com/apache/incubator-myriad/pull/50


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

Branch: refs/heads/master
Commit: d1129c8e4be1eecafc1e5e12220906f9308e9aca
Parents: 5b65ed0
Author: Sarjeet Singh <sarjeetsingh@maprtech.com>
Authored: Wed Dec 9 23:11:43 2015 -0800
Committer: smarella <smarella@maprtech.com>
Committed: Wed Dec 9 23:11:43 2015 -0800

----------------------------------------------------------------------
 docs/API.md | 44 ++++++++++++++++++++++++++++++++++++++++++--
 1 file changed, 42 insertions(+), 2 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/incubator-myriad/blob/d1129c8e/docs/API.md
----------------------------------------------------------------------
diff --git a/docs/API.md b/docs/API.md
index c975e28..97f5d84 100644
--- a/docs/API.md
+++ b/docs/API.md
@@ -8,11 +8,11 @@ API | HTTP Method | URI | Description |
 ----|-------------|-----|-------------|
 [Cluster](#cluster-api) | PUT | /api/cluster/flexup | Expands the cluster size |
 [Cluster](#cluster-api) | PUT | /api/cluster/flexdown | Shrinks the cluster size |
-[Service](#service-api) | PUT | /api/cluster/flexservice | Increases the number of instances
for a service. |
+[Service](#service-api) | PUT | /api/cluster/flexupservice | Increases the number of instances
for a service. |
 [Service](#service-api) | PUT | /api/cluster/flexdownservice | Shrinks the number of instances
for a service. |
 [Configuration](#configuration-api) | GET | /api/config | Retrieves the Myriad configuration.
|
 [State](#state-api) | GET | /api/state | Retrieves a snapshot of the Myriad Scheduler state.
|
-
+[Framework Shutdown](#framework-api) | GET | /api/framework/shutdown/framework | Shuts down
Myriad framework. |
 
 
 
@@ -482,6 +482,46 @@ Accept-Language: en-US,en;q=0.8
     "stagingTasks": []
 }
 ```
+
+
+## Framework API
+
+The Framework REST API uses the GET /api/framework/shutdown/framework HTTP method to shut
down myriad framework which shutdown web-server after stopping myriad driver, stop/clean all
myriad tasks and clean myriad state-store (if any).
+
+### HTTP Method and URI
+
+```
+GET /api/framework/shutdown/framework
+```
+
+### Syntax
+
+```
+<resource_manager_host>:8192/api/framework/shutdown/framework
+```
+
+### Request Example
+
+URL request example:
+
+```
+http://10.10.101.137:8192/api/framework/shutdown/framework
+```
+
+Curl request example:
+
+```
+curl http://10.10.101.137:8192/api/framework/shutdown/framework | python -m json.tool
+```
+
+Request header:
+
+```
+GET /api/framework/shutdown/framework HTTP/1.1
+User-Agent: curl/7.19.7 (x86_64-redhat-linux-gnu) libcurl/7.19.7 NSS/3.16.2.3 Basic ECC zlib/1.2.3
libidn/1.18 libssh2/1.4.2
+Host: 10.10.101.137:8192
+Accept: */*
+```
 ---
 <sub>
 Licensed to the Apache Software Foundation (ASF) under one


Mime
View raw message