diff options
| author |   Lovett, Trevor <trevor.lovett@att.com> | 2019-02-15 18:17:14 -0600 |
|---|---|---|
| committer | Lovett, Trevor <trevor.lovett@att.com> | 2019-02-16 08:47:41 -0600 |
| commit | bcbac1a1498b4f064fba575f7cbe8cb9b3663cd8 (patch) | |
| tree | 8a185fa51017e0788162dec8ffa5d9d9d7d697cc /docs/vvp_json_header.csv | |
| parent | 023d74cc2d436659398743c412a602c6c1777fcb (diff) | |
[VVP] Doc for GUI, Docker, and Deprecation
Revising documentation to reflect the deprecation
of the VVP web application as well as adding
documentation for the new additions such as:
* Alternate report options
* Native GUI tool
* Docker execution
Change-Id: Ia1b1e99e7d5fb657286efb281049e4550a80d1b6
Issue-ID: VVP-137
Signed-off-by: Lovett, Trevor (tl2972) <tl2972@att.com>
Diffstat (limited to 'docs/vvp_json_header.csv')
| -rw-r--r-- | docs/vvp_json_header.csv | 17 |
1 files changed, 17 insertions, 0 deletions
diff --git a/docs/vvp_json_header.csv b/docs/vvp_json_header.csv new file mode 100644 index 0000000..5827f8b --- /dev/null +++ b/docs/vvp_json_header.csv @@ -0,0 +1,17 @@ +Field Name,"Required/ +Optional/ +Conditional",Data Type,Valid Values,Description +``checksum``,Required,``string``,,MD5 hash of all file contents in the ``template_directory`` +``outcome``,Required,``string``,"``PASS`` +``FAIL`` +``ERROR``","One of the valid values: + +* ``PASS`` - All tests passed successfully (some may have been skipped as not applicable based on the contents of the template) +* ``FAIL`` - At least one test failed. In this scenario the templates will need to be corrected to comply with the requirements +* ``ERROR`` - An unexpected error occurred during test setup. Some or all tests may have not executed. Issue should be referred to the VVP team for investigation." +``categories``,Optional,array of ``string``,,Categories selected via the ``--category`` option. +``template_directory``,Required,``string``,,Absolute path of the directory containing the Heat templates that were validated +``version``,Required,``string``,,Version of the validation scripts that produced the report +``timestamp``,Required,``string``,,ISO 8601 Timestamp in UTC of when the report was generated +``tests``,Required,List of :ref:`Test Result <vvp-test-result>`,,See :ref:`Test Result <vvp-test-result>` +``requirements``,Required,List of :ref:`Requirement Result <vvp-req-result>`,,See :ref:`Requirement Result <vvp-req-result>` |