Add usage of testapi client

Change-Id: Ifacc61c5353e3975e625bb2843972cba6be79398
Signed-off-by: Yujun Zhang <zhang.yujunz@zte.com.cn>

diff --git a/qtip/reporter/testapi.py b/qtip/reporter/testapi.py
index 512dadd..2e4205e 100644 (file)
--- a/qtip/reporter/testapi.py
+++ b/qtip/reporter/testapi.py
@@ -7,8 +7,18 @@
 # http://www.apache.org/licenses/LICENSE-2.0
 ##############################################################################
 
-import requests
+# OPNFV Testapi Client
+#
+# API url: http://testresults.opnfv.org/test/api/v1
+# API spec:
+# - http://testresults.opnfv.org/test/swagger/spec.html#!/spec/queryTestResults
+# - http://testresults.opnfv.org/test/swagger/spec.html#!/spec/createTestResult
+# Login:
+#   username: opnfv
+#   password: contact admin
+# Self host: https://github.com/opnfv/releng/tree/master/utils/test/testapi/deployment
 
+import requests
 
 payload_template = {'project_name',
                     'case_name',