|
Provide full metadata objects for notifications?
EBALLOT PROPOSAL Provide a unified metadata model for tool notifications as well as tool analysis notifications (rendered as run.results). Many tool notifications need to be documented and handled in ways similar to literal analysis results.
API IMPACT
Rename the rule object to reportingDescriptor.
Move the rules array (now an array reportingDescriptor objects) out of run.resources and into toolComponent.ruleDescriptors.
Move the messageStrings array out of run.resources and into toolComponent.globalMessageStrings.
Introduce toolComponent.notificationDescriptors, also an array of reportingDescriptor objects.
Remove the run.resources property and the resources object.
Rename the ruleConfiguration object to reportingConfiguration.
Rename the rule.configuration property to reportingDescriptor.defaultConfiguration.
Rename ruleConfiguration.defaultLevel and ruleConfiguration.defaultRank simply to ruleConfiguration.level and ruleConfiguration.rank.
Persist the actual runtime rules configuration in a new array of reportingConfigurationOverride objects at invocation.reportingConfigurationOverrides.
https://github.com/oasis-tcs/sarif-spec/issues/311
|
