Interface GenerateDocumentationResult

The rendered documentation catalog plus the ownership/sensitivity findings it surfaces.

interface GenerateDocumentationResult {
    content: string;
    findings: readonly ReportFinding[];
    location: string;
}

Properties

content: string

The rendered Markdown content.

findings: readonly ReportFinding[]

Ownership/sensitivity findings surfaced while rendering.

location: string

Where this documentation is intended to be written.