summaryrefslogtreecommitdiffstats
path: root/api/swagger/docs/results.yaml
blob: 00b159003cb2957acd03c6e5fbd452c0d3d0a4b9 (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
##############################################################################
# Copyright (c) 2017 Huawei Technologies Co.,Ltd and others.
#
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Apache License, Version 2.0
# which accompanies this distribution, and is available at
# http://www.apache.org/licenses/LICENSE-2.0
##############################################################################
Query task result data

This api offer the interface to get the result data via task_id
We will return a result json dict
---
tags:
  - Results
parameters:
  -
    in: query
    name: action
    type: string
    default: getResult
    required: true
  -
    in: query
    name: measurement
    type: string
    description: test case name
    required: true
  -
    in: query
    name: task_id
    type: string
    description: the task_id you get before
    required: true
responses:
  200:
    description: a result json dict
    schema:
      id: ResultModel
      properties:
        status:
          type: string
          description: the status of the certain task
          default: success
        result:
          schema:
            type: array
            items:
              type: object