Documentation
¶
Index ¶
- func GenerateConfigReference(configPath string) (string, int, error)
- func GenerateJSONSchema(t reflect.Type) map[string]any
- func GenerateSchemaReferenceMarkdown(command string, root reflect.Type) string
- func RenderAuditorsOverviewMarkdown() string
- func RenderDetectorsOverviewMarkdown() string
- func RenderMatchersOverviewMarkdown() string
- func RenderSupportMatrixMarkdown() string
- func WriteCommandSchemaDocs(outputDir string) ([]string, error)
- func WriteCommandSchemas(outputDir string) ([]string, error)
- func WriteComponentDocs(docsDir string) error
- func WriteConfigReference(configPath, outputPath string) (int, error)
- func WriteSupportMatrix(outputPath string) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func GenerateConfigReference ¶
GenerateConfigReference renders the config reference markdown from the given config source file.
func GenerateJSONSchema ¶
GenerateJSONSchema produces a JSON-Schema-compatible map from the given type.
func GenerateSchemaReferenceMarkdown ¶
GenerateSchemaReferenceMarkdown produces markdown reference documentation for a root response type.
func RenderAuditorsOverviewMarkdown ¶
func RenderAuditorsOverviewMarkdown() string
RenderAuditorsOverviewMarkdown renders the human-readable auditor guide.
func RenderDetectorsOverviewMarkdown ¶
func RenderDetectorsOverviewMarkdown() string
RenderDetectorsOverviewMarkdown renders the human-readable detector guide.
func RenderMatchersOverviewMarkdown ¶
func RenderMatchersOverviewMarkdown() string
RenderMatchersOverviewMarkdown renders the human-readable matcher guide.
func RenderSupportMatrixMarkdown ¶
func RenderSupportMatrixMarkdown() string
RenderSupportMatrixMarkdown renders the canonical markdown support matrix document.
func WriteCommandSchemaDocs ¶
WriteCommandSchemaDocs writes markdown schema references for the supported command payloads.
func WriteCommandSchemas ¶
WriteCommandSchemas writes JSON schema files for the supported command payloads.
func WriteComponentDocs ¶
WriteComponentDocs writes generated detector and matcher documentation.
func WriteConfigReference ¶
WriteConfigReference writes the generated config reference markdown to disk.
func WriteSupportMatrix ¶
WriteSupportMatrix writes the generated support matrix markdown to disk.
Types ¶
This section is empty.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
componentdocs
command
|
|
|
configref
command
|
|
|
schemadocs
command
|
|
|
schemajson
command
|
|
|
supportmatrix
command
|