summaryrefslogtreecommitdiffstats
path: root/api/swagger/docs/testsuites_action.yaml
diff options
context:
space:
mode:
authorJingLu5 <lvjing5@huawei.com>2016-12-22 12:07:55 +0800
committerJingLu5 <lvjing5@huawei.com>2017-01-10 15:31:35 +0000
commit52ae99e54fc67614e71bf1920848bb7b16bcd153 (patch)
tree1590f685827ad1a91e550e3b013e3e25fb2dd224 /api/swagger/docs/testsuites_action.yaml
parent74479a22c461cc2c08f9525879481c0a86d3af84 (diff)
Create API to run test suite
JIRA: YARDSTICK-475 This API will be used to run test suite files in the test/opnfv/test_suites directory Change-Id: I208edf9abed62fd6436de988ac85bfe99c4d01bd Signed-off-by: JingLu5 <lvjing5@huawei.com>
Diffstat (limited to 'api/swagger/docs/testsuites_action.yaml')
-rw-r--r--api/swagger/docs/testsuites_action.yaml50
1 files changed, 50 insertions, 0 deletions
diff --git a/api/swagger/docs/testsuites_action.yaml b/api/swagger/docs/testsuites_action.yaml
new file mode 100644
index 000000000..ebf01e4ec
--- /dev/null
+++ b/api/swagger/docs/testsuites_action.yaml
@@ -0,0 +1,50 @@
+TestSuites Actions
+
+This API may offer many actions, including runTestSuite
+
+action: runTestSuite
+This api offer the interface to run a test suite in yardstick
+we will return a task_id for querying
+you can use the returned task_id to get the result data
+---
+tags:
+ - Testsuite Action
+parameters:
+ - in: body
+ name: body
+ description: this is the input json dict
+ schema:
+ id: TestSuiteActionModel
+ required:
+ - action
+ - args
+ properties:
+ action:
+ type: string
+ description: this is action for testsuite
+ default: runTestSuite
+ args:
+ schema:
+ id: TestSuiteActionArgsModel
+ required:
+ - testsuite
+ properties:
+ testsuite:
+ type: string
+ description: this is the test suite name
+ default: smoke
+ opts:
+ schema:
+ id: TestSuiteActionArgsOptsModel
+responses:
+ 200:
+ description: A result json dict
+ schema:
+ id: result
+ properties:
+ status:
+ type: string
+ default: success
+ result:
+ type: string
+ description: task_id of this task