Spaces:
Paused
Paused
File size: 3,474 Bytes
5a81b95 | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 | # DATABASE_VIEW_INTELLIGENCE_CATALOG.md Validation Report
## Validation Metadata
**Date:** 2025-11-25
**Validator:** Automated Script (validate-view-documentation.sh)
**Source Schema:** service.data.impl/src/main/resources/full_schema.sql
**Documentation File:** DATABASE_VIEW_INTELLIGENCE_CATALOG.md
**Validation Method:** Automated comparison script
**Repository:** Hack23/cia
---
## Executive Summary
This validation report confirms the current status of view documentation coverage.
### Current Status
| Metric | Value | Status |
|--------|-------|--------|
| **Total views in database** | 84 | ✓ Confirmed |
| **Total views documented** | 84 | ✅ Complete |
| **Documentation coverage** | 100.00% | ✅ Complete |
| **Views missing from documentation** | 0 | ✅ None |
| **Views documented but not in DB** | 0 | ✅ None |
### Severity Assessment
🟢 **OPTIMAL**: Documentation provides **100.00% coverage** for 84 database views.
### Progress Since Previous Validation (2025-11-25)
| Metric | Previous (2025-11-25) | Current (2025-11-25) | Improvement |
|--------|----------------------|---------------------|-------------|
| **Total views in database** | 82 | 84 | +2 |
| **Total views documented** | 9 | 84 | +75 views |
| **Documentation coverage** | 10.98% | 100.00% | +89.02% |
| **Views missing from documentation** | 73 | 0 | -73 views |
---
## Missing Views
✅ **All views are documented!** The DATABASE_VIEW_INTELLIGENCE_CATALOG.md now provides comprehensive coverage for all 84 database views.
---
## Next Steps
✅ **No action required.** Documentation is complete and up-to-date.
### Maintenance Tasks
1. **Monthly Validation**: This script runs automatically via GitHub Actions
2. **Schema Changes**: Update documentation when new views are added
3. **Quality Review**: Periodically review examples and performance metrics
4. **Cross-References**: Maintain links to related intelligence frameworks
---
## Validation Methodology
### Automated Process
This validation is performed by `validate-view-documentation.sh`:
1. **Extract Schema Views**: Parse full_schema.sql for CREATE VIEW statements
2. **Extract Documented Views**: Parse DATABASE_VIEW_INTELLIGENCE_CATALOG.md for view headers
3. **Compare Sets**: Identify missing and extra views using set operations
4. **Calculate Coverage**: Compute percentage of documented views
5. **Generate Report**: Create this markdown report with findings
### Commands Executed
```bash
# Extract views from schema
grep -E "^CREATE (OR REPLACE )?(MATERIALIZED )?VIEW" full_schema.sql | \
sed 's/.*VIEW //' | sed 's/ AS.*//' | sed 's/public\.//' | sort | uniq
# Extract documented views
grep -E "^### view_" DATABASE_VIEW_INTELLIGENCE_CATALOG.md | \
sed 's/### //' | awk '{print $1}' | sort | uniq
# Compare and calculate coverage
comm -23 schema_views.txt documented_views.txt > missing_views.txt
```
### Validation Schedule
- **Automated**: Monthly via GitHub Actions (1st of each month at 02:00 UTC)
- **Manual**: Can be triggered via workflow_dispatch
- **On Changes**: Runs automatically when schema or documentation changes
---
## Changelog
| Date | Coverage | Missing Views | Status |
|------|----------|---------------|--------|
| 2025-11-21 | 10.98% | 73 | Initial validation |
| 2025-11-25 | 100.00% | 0 | ✅ Complete |
---
**Report Status**: GENERATED
**Generated By**: validate-view-documentation.sh
**Next Validation**: 2025-12-01 02:00 UTC
|