Validation Error Messages (new json Format) - Gnorion/BizVR GitHub Wiki

• Seems like we should have a single consistent format for ALL messages that includes all the necessary data
• Maybe an array where each element is like this

Property	Type	Purpose	Example
SEVERITY	text	how serious is the issue	info, warn, error
TAB	text	which tab should the message go in	consistency, completeness, redundancy, attributes, values, input output, statistics, constraints, vocabulary, test cases, dependency
SUMMARY	text	brief statement of the issue	unused input "age"
GUIDS	array of guids	you don't care whether its a decision, ruleset, rule, condition or action guid right? you'll just highlight all the guids	["f6622882-b6af-5cea-81ea-fc237d30ee9c","9524a839-f831-5dcf-9d3d-b0499f2fd6bf"]
EXPLANATION	array of text	more details about the issue	variables declared as inputs need to be tested in rules or used as outputs
FIXIT	array of text	suggestions for fixing the issue - a list of options	["1. delete the input", "2. use the input"]

The Summary section at the start remains unchanged

Test Cases Remains Unchanged

{
    "Issues": [
        {
            "severity": "info",
            "tab": "consistency",
            "summary": "Input variable age is never used",
            "guids": [
                "f6622882-b6af-5cea-81ea-fc237d30ee9c",
                "9524a839-f831-5dcf-9d3d-b0499f2fd6bf"
            ],
            "explanation": [
                "You have declared the variable age as an input variable",
                "It is not tested in any rule and it is not declared as an output",
                "It does not appear to serve any purpose"
            ],
            "fixit": [
                "delete the input",
                "rename age to something that is used",
                "use age in a rule condition",
                "declare age as an output"
            ]
        }
    ]
}