aboutsummaryrefslogtreecommitdiffstats
path: root/api/swagger/docs/testsuites_action.yaml
blob: ebf01e4ec26b6b7eb66e0f9c176105a6b0a34857 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
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