Redfish-Service-Validator icon indicating copy to clipboard operation
Redfish-Service-Validator copied to clipboard

Published 20 hours ago • verified publisher icon DMTF

Error and Warning Message Scrub

Open mraineri opened this issue 3 months ago • 0 comments

The error and warning messages produced by the tool and included in the HTML reports require review and scrubbing. For users familiar with the tool and its workings, the existing messages suffice to help diagnose service issue. However, to untrained users, the messages and be daunting and not easily describe the real issue. Some examples…

  • err.Resource.Name
    • This could be displayed as “Required property missing: Name”
  • invalidNamedProperty.complex
    • This could be displayed as “Unknown property: <Insert property from the service>”
  • err.Edm.DateTimeOffset
    • This could be displayed as “Invalid format for property DateTimeOffset: <Insert expected pattern>”

A careful review of the tool is required to enhance the messages used to produce something more novice friendly.

mraineri avatar Oct 25 '24 19:10 mraineri