summaryrefslogtreecommitdiffstats
path: root/api/swagger
diff options
context:
space:
mode:
authorchenjiankun <chenjiankun1@huawei.com>2017-03-28 13:51:42 +0000
committerJing Lu <lvjing5@huawei.com>2017-03-29 01:26:33 +0000
commit42f2d416079ebe41a1f4d7a01cdb7896a871ad51 (patch)
tree88fccd527ebc671d87f64571539db1fa207c7433 /api/swagger
parentaf004096fa17c9e29c663fc013228a9c82bd174d (diff)
Bugfix: improper license header in swagger docs
JIRA: YARDSTICK-609 In the patch: https://gerrit.opnfv.org/gerrit/#/c/28833/ It update the license header, but it is improper to swagger yaml file. The license information will show in swagger docs. So I remove it. Change-Id: Ib87f0f43a95e3b2145c4b59059c4573000f1997c Signed-off-by: chenjiankun <chenjiankun1@huawei.com> (cherry picked from commit 6e77001bcd07f30f9edcf4103528002f4c4ec536)
Diffstat (limited to 'api/swagger')
-rw-r--r--api/swagger/docs/release_action.yaml108
-rw-r--r--api/swagger/docs/results.yaml8
-rw-r--r--api/swagger/docs/testsuites_action.yaml8
3 files changed, 50 insertions, 74 deletions
diff --git a/api/swagger/docs/release_action.yaml b/api/swagger/docs/release_action.yaml
index 0e08e582f..0a6968bc5 100644
--- a/api/swagger/docs/release_action.yaml
+++ b/api/swagger/docs/release_action.yaml
@@ -1,58 +1,50 @@
-##############################################################################
-# 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
-##############################################################################
-TestCases Actions
-
-This API may offer many actions, including runTestCase
-
-action: runTestCase
-This api offer the interface to run a test case in yardstick
-we will return a task_id for querying
-you can use the returned task_id to get the result data
----
-tags:
- - Release Action
-parameters:
- - in: body
- name: body
- description: this is the input json dict
- schema:
- id: TestCaseActionModel
- required:
- - action
- - args
- properties:
- action:
- type: string
- description: this is action for testcases
- default: runTestCase
- args:
- schema:
- id: TestCaseActionArgsModel
- required:
- - testcase
- properties:
- testcase:
- type: string
- description: this is the test case name
- default: tc002
- opts:
- schema:
- id: TestCaseActionArgsOptsModel
-responses:
- 200:
- description: A result json dict
- schema:
- id: result
- properties:
- status:
- type: string
- default: success
- result:
- type: string
- description: task_id of this task
+TestCases Actions
+
+This API may offer many actions, including runTestCase
+
+action: runTestCase
+This api offer the interface to run a test case in yardstick
+we will return a task_id for querying
+you can use the returned task_id to get the result data
+---
+tags:
+ - Release Action
+parameters:
+ - in: body
+ name: body
+ description: this is the input json dict
+ schema:
+ id: TestCaseActionModel
+ required:
+ - action
+ - args
+ properties:
+ action:
+ type: string
+ description: this is action for testcases
+ default: runTestCase
+ args:
+ schema:
+ id: TestCaseActionArgsModel
+ required:
+ - testcase
+ properties:
+ testcase:
+ type: string
+ description: this is the test case name
+ default: tc002
+ opts:
+ schema:
+ id: TestCaseActionArgsOptsModel
+responses:
+ 200:
+ description: A result json dict
+ schema:
+ id: result
+ properties:
+ status:
+ type: string
+ default: success
+ result:
+ type: string
+ description: task_id of this task
diff --git a/api/swagger/docs/results.yaml b/api/swagger/docs/results.yaml
index 00b159003..7bdab3eb6 100644
--- a/api/swagger/docs/results.yaml
+++ b/api/swagger/docs/results.yaml
@@ -1,11 +1,3 @@
-##############################################################################
-# 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
diff --git a/api/swagger/docs/testsuites_action.yaml b/api/swagger/docs/testsuites_action.yaml
index ca8d22738..ebf01e4ec 100644
--- a/api/swagger/docs/testsuites_action.yaml
+++ b/api/swagger/docs/testsuites_action.yaml
@@ -1,11 +1,3 @@
-##############################################################################
-# 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
-##############################################################################
TestSuites Actions
This API may offer many actions, including runTestSuite