Merge "Add smoke, components, features and performance test suite for Yatdstick"
[yardstick.git] / api / swagger / docs / testcases.yaml
1 TestCases Actions\r
2 \r
3 This API may offer many actions, including runTestCase\r
4 \r
5 action: runTestCase\r
6 This api offer the interface to run a test case in yardstick\r
7 we will return a task_id for querying\r
8 you can use the returned task_id to get the result data\r
9 ---\r
10 tags:\r
11   - Release Action\r
12 parameters:\r
13   - in: body\r
14     name: body\r
15     description: this is the input json dict\r
16     schema:\r
17       id: TestCaseActionModel\r
18       required:\r
19         - action\r
20         - args\r
21       properties:\r
22         action:\r
23           type: string\r
24           description: this is action for testcases\r
25           default: runTestCase\r
26         args:\r
27           schema:\r
28             id: TestCaseActionArgsModel\r
29             required:\r
30               - testcase\r
31             properties:\r
32               testcase:\r
33                 type: string\r
34                 description: this is the test case name\r
35                 default: tc002\r
36               opts:\r
37                 schema:\r
38                   id: TestCaseActionArgsOptsModel\r
39 responses:\r
40   200:\r
41     description: A result json dict\r
42     schema:\r
43       id: result\r
44       properties:\r
45         status:\r
46           type: string\r
47           default: success\r
48         result:\r
49           type: string\r
50           description: task_id of this task\r