diff options
| -rw-r--r-- | docs/devguide/index.rst | 13 |
1 files changed, 7 insertions, 6 deletions
diff --git a/docs/devguide/index.rst b/docs/devguide/index.rst index cda38e0ed..da134bc76 100644 --- a/docs/devguide/index.rst +++ b/docs/devguide/index.rst @@ -336,7 +336,7 @@ The Test result management can be summarized as follows:: Test API description ==================== The Test API is used to declare pods, projects, test cases and test results. An -additional method dashboard has been added to post-process the raw results in release Brahmaputra. +additional method dashboard has been added to post-process the raw results in release Brahmaputra. The data model is very basic, 4 objects are created: * Pods @@ -349,7 +349,7 @@ Pods:: { "id": <ID>, "details": <URL description of the POD>, - "creation_date": YYYY-MM-DD HH:MM:SS , + "creation_date": "YYYY-MM-DD HH:MM:SS", "name": <The POD Name>, "mode": <metal or virtual>, "role": <ci-pod or community-pod or single-node> @@ -378,8 +378,8 @@ Testcases:: Results:: { - "_id": <ID, - "case_name": <Reference to the test case> + "_id": <ID>, + "case_name": <Reference to the test case>, "project_name": <Reference to project>, "pod_name": <Reference to POD where the test was executed>, "installer": <Installer Apex or Compass or Fuel or Joid>, @@ -389,14 +389,15 @@ Results:: "build_tag": <such as "jenkins-functest-fuel-baremetal-daily-master-108">, "scenario": <Scenario on which the test was executed>, "criteria": <PASS or FAILED>, - "trust_indicator": <0 ~ 1> + "trust_indicator": <0~1> + } The API can described as follows. For detailed information, please go to http://testresults.opnfv.org/test/swagger/spec.html Authentication: opnfv/api@opnfv -Please notes that POST/DELETE/PUT operations for test or study purpose via +Please notes that POST/DELETE/PUT operations for test or study purpose via swagger website is not allowed, because it will change the real data in the database. |