api/swagger/docs/release_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 TestCases Actions\r
  10 \r
  11 This API may offer many actions, including runTestCase\r
  12 \r
  13 action: runTestCase\r
  14 This api offer the interface to run a test case in yardstick\r
  15 we will return a task_id for querying\r
  16 you can use the returned task_id to get the result data\r
  17 ---\r
  18 tags:\r
  19   - Release Action\r
  20 parameters:\r
  21   - in: body\r
  22     name: body\r
  23     description: this is the input json dict\r
  24     schema:\r
  25       id: TestCaseActionModel\r
  26       required:\r
  27         - action\r
  28         - args\r
  29       properties:\r
  30         action:\r
  31           type: string\r
  32           description: this is action for testcases\r
  33           default: runTestCase\r
  34         args:\r
  35           schema:\r
  36             id: TestCaseActionArgsModel\r
  37             required:\r
  38               - testcase\r
  39             properties:\r
  40               testcase:\r
  41                 type: string\r
  42                 description: this is the test case name\r
  43                 default: tc002\r
  44               opts:\r
  45                 schema:\r
  46                   id: TestCaseActionArgsOptsModel\r
  47 responses:\r
  48   200:\r
  49     description: A result json dict\r
  50     schema:\r
  51       id: result\r
  52       properties:\r
  53         status:\r
  54           type: string\r
  55           default: success\r
  56         result:\r
  57           type: string\r
  58           description: task_id of this task\r