summaryrefslogtreecommitdiffstats
path: root/docs/vvp_json_req_result.csv
diff options
context:
space:
mode:
Diffstat (limited to 'docs/vvp_json_req_result.csv')
-rw-r--r--docs/vvp_json_req_result.csv17
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/vvp_json_req_result.csv b/docs/vvp_json_req_result.csv
new file mode 100644
index 0000000..42b96b0
--- /dev/null
+++ b/docs/vvp_json_req_result.csv
@@ -0,0 +1,17 @@
+Field Name,Required/Optional/Conditional,Data Type,Valid Values,Description
+``id``,Required,``string``,,"Requirement ID from the VNFRQTS project.
+
+**NOTE**:a requirement ID of ""Unmapped"" may be included if one or more tests are not mapped to a requirement."
+``text``,Required,``string``,,Full text of the requirement.
+``keyword``,Required,``string``,"``MUST``,
+``MUST NOT``,
+``MAY``,
+``""SHOULD""``,
+``""SHOULD NOT""``",RFC 2119 keyword associated with the requirement
+``result``,Required,``string``,"``PASS``, ``SKIP``, ``FAIL``, ``ERROR``","One of the valid values:
+
+* ``PASS`` - The test case passed with no violations
+* ``SKIP`` - The test case was skipped because it was deemed not applicable
+* ``FAIL`` - The test case completed, but it found a violation
+* ``ERROR`` - An unexpected error was found while setting up the test case"
+``errors``,Required,List of ``string``,,Error messages associated with this requirement. This will be an empty string if the result is ``PASS`` or ``SKIP``