summaryrefslogtreecommitdiffstats
path: root/api/swagger/docs/results.yaml
diff options
context:
space:
mode:
authorchenjiankun <chenjiankun1@huawei.com>2016-12-01 01:51:16 +0000
committerchenjiankun <chenjiankun1@huawei.com>2016-12-01 07:54:03 +0000
commitccdca64bafb07057dd482cf04da7bf9e64dc1928 (patch)
tree761c7e81cc905ca330dae56b1445ff59ca0b7454 /api/swagger/docs/results.yaml
parent2c9574a29c95abafb4d06eb76a18fba9930ec41b (diff)
Add swagger support for Rest API
JIRA: YARDSTICK-439 Change-Id: I36ad0663455c51d635c4329f5cbb9da25d8042e1 Signed-off-by: chenjiankun <chenjiankun1@huawei.com>
Diffstat (limited to 'api/swagger/docs/results.yaml')
-rw-r--r--api/swagger/docs/results.yaml41
1 files changed, 41 insertions, 0 deletions
diff --git a/api/swagger/docs/results.yaml b/api/swagger/docs/results.yaml
new file mode 100644
index 000000000..7bdab3eb6
--- /dev/null
+++ b/api/swagger/docs/results.yaml
@@ -0,0 +1,41 @@
+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