functest/api/swagger/envs_action.yaml

   1 Prepare environment or Update hosts info
   2
   3 This api offers the interface to prepare environment or update hosts info.
   4
   5 action: prepare
   6 action: update_hosts
   7 ---
   8 tags:
   9   - Envs
  10 parameters:
  11   - in: body
  12     name: body
  13     description: this is the input json dict
  14     schema:
  15       required:
  16         - action
  17       properties:
  18         action:
  19           type: string
  20           description: this is action for envs
  21           default: prepare
  22 definitions:
  23   Environment:
  24     type: object
  25     properties:
  26       creds_name:
  27           $ref: '#/definitions/Name'
  28   Name:
  29     type: dict
  30 responses:
  31   200:
  32     description: Prepare environment
  33     schema:
  34       $ref: '#/definitions/Environment'
  35     examples:
  36       'status': 0
  37       'result': 'Prapare env successfully'