api/swagger/docs/results.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 Query task result data
  10
  11 This api offer the interface to get the result data via task_id
  12 We will return a result json dict
  13 ---
  14 tags:
  15   - Results
  16 parameters:
  17   -
  18     in: query
  19     name: action
  20     type: string
  21     default: getResult
  22     required: true
  23   -
  24     in: query
  25     name: measurement
  26     type: string
  27     description: test case name
  28     required: true
  29   -
  30     in: query
  31     name: task_id
  32     type: string
  33     description: the task_id you get before
  34     required: true
  35 responses:
  36   200:
  37     description: a result json dict
  38     schema:
  39       id: ResultModel
  40       properties:
  41         status:
  42           type: string
  43           description: the status of the certain task
  44           default: success
  45         result:
  46           schema:
  47             type: array
  48             items:
  49               type: object