RuleReportData
Report data for a specific RuleReport violation.
Properties
Section titled “Properties”primary
Section titled “primary”primary:
string
Single sentence description of the reported violation.
Example
Section titled “Example”"The following image is missing alt text:"secondary?
Section titled “secondary?”
optionalsecondary:string[]
Any additional sentences detailing the violation.
Example
Section titled “Example”["> [](img.jpg)"]suggestion
Section titled “suggestion”suggestion:
string[]
Steps the user can take to resolve the violation.
Example
Section titled “Example”"To resolve this report, add descriptive alt text to the image."action?
Section titled “action?”
optionalaction:"close"
Optional action to take on the entity after the report comment is posted.
Example
Section titled “Example”"close"