functest/api/swagger/testcase_run.yaml

   1 ---
   2 Run a test case
   3
   4 This api offers the interface to run a test case
   5 ---
   6 tags:
   7     - Testcases
   8 parameters:
   9     - in: body
  10       name: body
  11       description: this is the input json dict
  12       schema:
  13           required:
  14               - action
  15               - args
  16           properties:
  17               action:
  18                   type: string
  19                   description: this is action for creds
  20                   default: run_test_case
  21               args:
  22                   schema:
  23                       required:
  24                           - testcase
  25                       properties:
  26                           testcase:
  27                               type: string
  28                               description: this is the test case name
  29                               default:
  30                                   vping_ssh
  31 definitions:
  32     Testcases:
  33         type: object
  34         properties:
  35             creds_name:
  36                 $ref: '#/definitions/Tests'
  37     Tests:
  38         type: dict
  39 responses:
  40     200:
  41         description: Run a test case
  42         schema:
  43             $ref: '#/definitions/Testcases'
  44         examples:
  45             'task_id': '94c8ec94-d873-466f-a205-bf592f31ff5b'
  46             'testcase': 'vping_ssh'