diff options
| author |   Linda Wang <wangwulin@huawei.com> | 2017-09-12 07:37:19 +0000 |
|---|---|---|
| committer | Linda Wang <wangwulin@huawei.com> | 2017-09-19 10:33:39 +0000 |
| commit | b621b6b4b70299a60ad3e26ed6b04450f84b603e (patch) | |
| tree | 540adb705c5d3a32dbdf6c797292392bda0af140 /functest/api/swagger/task.yaml | |
| parent | c3c326570b29276d5ac2f703f64fb5f797de62d2 (diff) | |
Add swagger support for Rest API
JIRA: FUNCTEST-854
Change-Id: Ic010604d3ba0cc46092cf2a1ae8bb41afa73c920
Signed-off-by: Linda Wang <wangwulin@huawei.com>
Diffstat (limited to 'functest/api/swagger/task.yaml')
| -rw-r--r-- | functest/api/swagger/task.yaml | 38 |
1 files changed, 38 insertions, 0 deletions
diff --git a/functest/api/swagger/task.yaml b/functest/api/swagger/task.yaml new file mode 100644 index 00000000..abf68a0d --- /dev/null +++ b/functest/api/swagger/task.yaml @@ -0,0 +1,38 @@ +Get the result of the specified task + +This api offers the interface to get the result of the specified task. + +--- +tags: + - Tasks +parameters: + - name: task_id + description: task id + in: path + type: string + required: true +definitions: + Task: + type: object + properties: + creds_name: + $ref: '#/definitions/Result' + Result: + type: dict +responses: + 200: + description: Get the result of the specified task + schema: + $ref: '#/definitions/Task' + examples: + "result": { + "case_name": "vping_ssh", + "env_info": { + "build_tag": null, + "ci_loop": "weekly", + "installer": "compass", + "scenario": "os-nosdn-nofeature-noha" }, + "result": "PASS", + "task_id": "1a9f3c5d-ce0b-4354-862e-dd08b26fc484"} + "status": 2 + |