api/swagger/docs/testsuites_action.yaml

   1 ##############################################################################
   2 # Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
   3 #
   4 # All rights reserved. This program and the accompanying materials
   5 # are made available under the terms of the Apache License, Version 2.0
   6 # which accompanies this distribution, and is available at
   7 # http://www.apache.org/licenses/LICENSE-2.0
   8 ##############################################################################
   9 TestSuites Actions
  10
  11 This API may offer many actions, including runTestSuite
  12
  13 action: runTestSuite
  14 This api offer the interface to run a test suite in yardstick
  15 we will return a task_id for querying
  16 you can use the returned task_id to get the result data
  17 ---
  18 tags:
  19   - Testsuite Action
  20 parameters:
  21   - in: body
  22     name: body
  23     description: this is the input json dict
  24     schema:
  25       id: TestSuiteActionModel
  26       required:
  27         - action
  28         - args
  29       properties:
  30         action:
  31           type: string
  32           description: this is action for testsuite
  33           default: runTestSuite
  34         args:
  35           schema:
  36             id: TestSuiteActionArgsModel
  37             required:
  38               - testsuite
  39             properties:
  40               testsuite:
  41                 type: string
  42                 description: this is the test suite name
  43                 default: smoke
  44               opts:
  45                 schema:
  46                   id: TestSuiteActionArgsOptsModel
  47 responses:
  48   200:
  49     description: A result json dict
  50     schema:
  51       id: result
  52       properties:
  53         status:
  54           type: string
  55           default: success
  56         result:
  57           type: string
  58           description: task_id of this task