aboutsummaryrefslogtreecommitdiffstats
path: root/functest/api/swagger/envs_action.yaml
diff options
context:
space:
mode:
authorLinda Wang <wangwulin@huawei.com>2017-09-12 07:37:19 +0000
committerLinda Wang <wangwulin@huawei.com>2017-09-19 10:33:39 +0000
commitb621b6b4b70299a60ad3e26ed6b04450f84b603e (patch)
tree540adb705c5d3a32dbdf6c797292392bda0af140 /functest/api/swagger/envs_action.yaml
parentc3c326570b29276d5ac2f703f64fb5f797de62d2 (diff)
Add swagger support for Rest API
JIRA: FUNCTEST-854 Change-Id: Ic010604d3ba0cc46092cf2a1ae8bb41afa73c920 Signed-off-by: Linda Wang <wangwulin@huawei.com>
Diffstat (limited to 'functest/api/swagger/envs_action.yaml')
-rw-r--r--functest/api/swagger/envs_action.yaml37
1 files changed, 37 insertions, 0 deletions
diff --git a/functest/api/swagger/envs_action.yaml b/functest/api/swagger/envs_action.yaml
new file mode 100644
index 00000000..1add066e
--- /dev/null
+++ b/functest/api/swagger/envs_action.yaml
@@ -0,0 +1,37 @@
+Prepare environment or Update hosts info
+
+This api offers the interface to prepare environment or update hosts info.
+
+action: prepare
+action: update_hosts
+---
+tags:
+ - Envs
+parameters:
+ - in: body
+ name: body
+ description: this is the input json dict
+ schema:
+ required:
+ - action
+ properties:
+ action:
+ type: string
+ description: this is action for envs
+ default: prepare
+definitions:
+ Environment:
+ type: object
+ properties:
+ creds_name:
+ $ref: '#/definitions/Name'
+ Name:
+ type: dict
+responses:
+ 200:
+ description: Prepare environment
+ schema:
+ $ref: '#/definitions/Environment'
+ examples:
+ 'status': 0
+ 'result': 'Prapare env successfully'