API Reference
Class
RuleGuidance
Optional structured guidance for a rule (portable, inline).
Inheritance
- Object
- RuleGuidance
Constructors
public RuleGuidance() #Inherited Methods
Properties
public String Summary { get; set; } #Short, reader‑friendly summary of the risk or configuration.
public String WhyItMatters { get; set; } #Explains impact and rationale behind the rule.
public List<String> HowToInvestigate { get; } #Suggested steps to triage and collect more evidence.
public List<String> HowToFix { get; } #Recommended remediation steps.
public List<String> References { get; } #Links to documentation and references.
public List<RuleExample> Examples { get; } #Code or command examples for documentation.
public Boolean SummaryIsMarkdown { get; set; } #Whether the Summary is provided in Markdown.
public Boolean WhyItMattersIsMarkdown { get; set; } #Whether WhyItMatters is provided in Markdown.
public Boolean HowToInvestigateIsMarkdown { get; set; } #Whether HowToInvestigate items are Markdown-formatted.
public Boolean HowToFixIsMarkdown { get; set; } #Whether HowToFix items are Markdown-formatted.