Updating notes for 1.0.0

Author: mraineri

AUTHORS.md

@@ -1,5 +1,3 @@
-
 # Original Contribution:
-* Majec Systems
 
-# Other Key Contributions:
+* Majec Systems

CHANGELOG.md

@@ -1,3 +1,4 @@
-
 # Change Log
 
+## [1.0.0] - 2018-01-26
+- Initial release; conformant with version 1.0.0 of DSP0272

README.md

@@ -1,13 +1,17 @@
-Copyright 2017 Distributed Management Task Force, Inc. All rights reserved.
-# Redfish Interop Validator - Version 0.91
+Copyright 2017-2018 Distributed Management Task Force, Inc. All rights reserved.
+
+# Redfish Interop Validator
 
 ## About
+
 The Redfish Interop Validator is a python3 tool that will validate a service based on an Interoperability profile given to the tool.  The purpose of the tool is to guarantee that a specific service is compatible with vendor systems or system tools based on a vendor's specification in a profile.
 
 ## Introduction
+
 This tool is designed to accept a profile conformant to the schematics specified by the DMTF Redfish Profile schema, and run against any valid Redfish service for a given device.  It is not biased to any specific hardware, only dependent on the current Redfish specification.
 
 ## Pre-requisites
+
 The Redfish Interop Validator is based on Python 3 and the client system is required to have the Python framework installed before the tool can be installed and executed on the system. Additionally, the following packages are required to be installed and accessible from the python environment:
 * beautifulsoup4  - https://pypi.python.org/pypi/beautifulsoup4/4.5.3 (must be <= 4.5.3)
 * requests  - https://github.com/kennethreitz/requests (Documentation is available at http://docs.python-requests.org/)
@@ -25,9 +29,11 @@ pip3 install beautifulsoup4 --upgrade
 There is no dependency based on Windows or Linux OS. The result logs are generated in HTML format and an appropriate browser (Chrome, Firefox, IE, etc.) is required to view the logs on the client system.
 
 ## Installation
+
 The RedfishInteropValidator.py into the desired tool root directory.  Create the following subdirectories in the tool root directory: "config", "logs", "SchemaFiles".  Place the example config.ini file in the "config" directory.  Place the CSDL Schema files to be used by the tool in the root of the schema directory, or the directory given in config.ini.
 
 ## Execution Steps
+
 The Redfish Interop Validator is designed to execute as a purely command line interface tool with no intermediate inputs expected during tool execution. However, the tool requires various inputs regarding system details, DMTF schema files etc. which are consumed by the tool during execution to generate the conformance report logs. Below are the step by step instructions on setting up the tool for execution on any identified Redfish device for conformance test:
 
 Modify the config\config.ini file to enter the system details under below section
@@ -97,6 +103,7 @@ In order to run without a configuration file, the option --ip must be specified.
 python3 RedfishInteropValidator.py profileName --ip host:port [...]
 
 ## Execution flow
+
 * 1.	Redfish Interop Validator starts with the Service root Resource Schema by querying the service with the service root URI and getting all the device information, the resources supported and their links. Once the response of the Service root query is verified against a given profile (given the profile contains specifications for ServiceRoot), the tool traverses through all the collections and Navigation properties returned by the service.
 * 2.	For each navigation property/Collection of resource returned, it does following operations:
 ** i.	Reads all the Navigation/collection of resources from the respective resource collection schema file.
@@ -126,6 +133,7 @@ Upon validation of a resource, the following types of tests may occur:
   * For collections, validate each property inside of itself, and expects a list rather than a single Property, otherwise validate normally:
 
 ## Conformance Logs – Summary and Detailed Conformance Report
+
 The Redfish Interop Validator generates an html report under the “logs” folder, named as  The report gives the detailed view of the individual properties checked, with the Pass/Fail/Skip/Warning status for each resource checked for conformance.
 
 There is a verbose log file that may be referenced to diagnose tool or schema problems when the stdout print out is insufficient, located in logs/ConformanceLog_MM_DD_YYYY_HHMMSS.html