summaryrefslogtreecommitdiffstats
path: root/dovetail/api/swagger.yaml
diff options
context:
space:
mode:
authorxudan <xudan16@huawei.com>2019-06-27 04:37:55 -0400
committerDan Xu <xudan16@huawei.com>2019-07-10 03:09:06 +0000
commit1f36d6247578273197a4ba64b58b02b1ed837171 (patch)
treea8049bb2a3523c678ff16741cf754993fd8e9fd5 /dovetail/api/swagger.yaml
parent1aafeb7eeef0a870d0c4cef95c929b66fd8ad991 (diff)
Add Swagger UI for dovetail API
Change-Id: If8f515b02f0372955739dd580967a3198930e98b Signed-off-by: xudan <xudan16@huawei.com>
Diffstat (limited to 'dovetail/api/swagger.yaml')
-rw-r--r--dovetail/api/swagger.yaml54
1 files changed, 54 insertions, 0 deletions
diff --git a/dovetail/api/swagger.yaml b/dovetail/api/swagger.yaml
new file mode 100644
index 00000000..5df0dcc2
--- /dev/null
+++ b/dovetail/api/swagger.yaml
@@ -0,0 +1,54 @@
+swagger: "2.0"
+info:
+ description: "This is the dovetail API."
+ version: "1.0.0"
+ title: "Dovetail API"
+ contact:
+ email: "xudan16@huawei.com"
+ license:
+ name: "Apache 2.0"
+ url: "http://www.apache.org/licenses/LICENSE-2.0.html"
+host: localhost:8888
+basePath: "/api/v1/scenario/nfvi"
+tags:
+- name: "testsuites"
+ description: "Operations about testsuites"
+- name: "testcases"
+ description: "Operations about test cases"
+schemes:
+- "http"
+paths:
+ /testsuites:
+ get:
+ tags:
+ - "testsuites"
+ summary: "Get all testsuites"
+ description: ""
+ operationId: "getTestsuites"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters: []
+ responses:
+ 200:
+ description: "successful operation"
+ default:
+ description: Unexpected error
+ /testcases:
+ get:
+ tags:
+ - "testcases"
+ summary: "Get all test cases"
+ description: ""
+ operationId: "getTestcases"
+ consumes:
+ - "application/json"
+ produces:
+ - "application/json"
+ parameters: []
+ responses:
+ 200:
+ description: "successful operation"
+ default:
+ description: Unexpected error