Skip to content

Archive & examples

The project accumulated a large set of working artifacts in docs/ over its build-out — sample reports, vendor API specs, one-off scripts, and running design/status notes. Those were reorganized out of the Starlight app root into two places:

  • docs/public/examples/ — sample outputs, served by this site (download links below).
  • docs/_legacy/ — historical notes, vendor API specs, and scripts, kept as an in-repo reference (paths below).

Example outputs (downloadable)

Real sample outputs produced by the vulnmgmt engine’s reporting subsystem.

Branded reports (DOCX)

Spreadsheets (XLSX) & CSV

Representative Excel/CSV exports (asset inventories, per-vendor enrichment runs, version tracking). Under docs/public/examples/reports/:

KindExamples
Full asset inventorycomplete_report_all_assets.xlsx
Per-vendor enrichment (Foxit)foxit_comprehensive_report.xlsx, foxit_final_report.xlsx, foxit_full_enrichment_report.xlsx
Rapid7 runsrapid7_complete_system_report.xlsx, rapid7_enriched_report.xlsx, rapid7_final_report.xlsx, rapid7_vulns.xlsx
Version trackingversion_tracking.xlsx, version_tracking_new.xlsx
CSVserver_report.csv, server_full_details.csv, server_with_cves.csv

Sample data (JSON)

Under docs/public/examples/data/ — intermediate enrichment payloads used while developing the pipeline (converted_apps.json, foxit_*.json, test_*.json).

Vendor API specs

Reference API schemas captured while building the integrations, in docs/_legacy/api-specs/:

FileVendor
insightvm-api-v4.jsonRapid7 InsightVM (OpenAPI)
s1_swagger_2_1.jsonSentinelOne (Swagger 2.1)
api-v3.jsonConnectWise (v3)
microsoft_top10.jsonMicrosoft reference data
RAPID7_API_ENDPOINTS.md, RAPID7_CORRECT_API.mdRapid7 endpoint notes

See the Integrations section for the current, implemented behavior — these specs are the raw source material.

Historical design & status notes

Preserved in docs/_legacy/notes/ (30 files). These are point-in-time design records and migration status logs — superseded by the current docs, but kept for provenance. Highlights worth reading:

TopicFiles
System designENTERPRISE_SYSTEM_DESIGN.md, vuln_mgmt_suite_architecture.md, ARCHITECTURE_REVIEW.md
IntegrationsINTEGRATIONS.md, INTEGRATION_SUMMARY.md, ENRICHMENT_SOURCES.md, FREE_THREAT_INTEL_APIS.md, XFORCE_INTEGRATION.md
CLI & usageCLI_USAGE_GUIDE.md, CPE_USAGE_GUIDE.md, FILTERING_GUIDE.md, vuln_mgmt_implementation_guide.md
ReportingDOCX_TEMPLATE_ANALYSIS.md, DOCX_IMPLEMENTATION_REVIEW.md, DOCX_BRANDING_COMPLETE.md
CW Automate scoping / durable jobsconnectwise-automate-scoping-and-durable-workflows.md (now Operations → Durable workflows)

One-off scripts

Exploration/test scripts in docs/_legacy/scripts/ (discover_rapid7_api.py, replicate_existing_reports.py, test_rapid7*.py, analyze_existing_reports.py, install.sh) — kept for reference; not part of the running system.