api/swagger/docs/testsuites_action.yaml

   1 TestSuites Actions
   2
   3 This API may offer many actions, including runTestSuite
   4
   5 action: runTestSuite
   6 This api offer the interface to run a test suite in yardstick
   7 we will return a task_id for querying
   8 you can use the returned task_id to get the result data
   9 ---
  10 tags:
  11   - Testsuite Action
  12 parameters:
  13   - in: body
  14     name: body
  15     description: this is the input json dict
  16     schema:
  17       id: TestSuiteActionModel
  18       required:
  19         - action
  20         - args
  21       properties:
  22         action:
  23           type: string
  24           description: this is action for testsuite
  25           default: runTestSuite
  26         args:
  27           schema:
  28             id: TestSuiteActionArgsModel
  29             required:
  30               - testsuite
  31             properties:
  32               testsuite:
  33                 type: string
  34                 description: this is the test suite name
  35                 default: smoke
  36               opts:
  37                 schema:
  38                   id: TestSuiteActionArgsOptsModel
  39 responses:
  40   200:
  41     description: A result json dict
  42     schema:
  43       id: result
  44       properties:
  45         status:
  46           type: string
  47           default: success
  48         result:
  49           type: string
  50           description: task_id of this task