Merge "Create API to run test suite"

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