Files
breakpilot-compliance/docs-src/services/sdk-modules/versionierung.md
Benjamin Admin 1e84df9769
All checks were successful
CI / go-lint (push) Has been skipped
CI / python-lint (push) Has been skipped
CI / nodejs-lint (push) Has been skipped
CI / test-go-ai-compliance (push) Successful in 32s
CI / test-python-backend-compliance (push) Successful in 30s
CI / test-python-document-crawler (push) Successful in 21s
CI / test-python-dsms-gateway (push) Successful in 18s
feat(sdk): Multi-Tenancy, Versionierung, Change-Requests, Dokumentengenerierung (Phase 1-6)
6-Phasen-Implementation fuer cloud-faehiges, mandantenfaehiges Compliance SDK:

Phase 1: Multi-Tenancy Fix
- Shared tenant_utils.py Dependency (UUID-Validierung, kein "default" mehr)
- VVT tenant_id Column + tenant-scoped Queries
- DSFA/Vendor DEFAULT_TENANT_ID von "default" auf UUID migriert
- Migration 035

Phase 2: Stammdaten-Erweiterung
- Company Profile um JSONB-Felder erweitert (processing_systems, ai_systems, technical_contacts)
- Regulierungs-Flags (NIS2, AI Act, ISO 27001)
- GET /template-context Endpoint
- Migration 036

Phase 3: Dokument-Versionierung
- 5 Versions-Tabellen (DSFA, VVT, TOM, Loeschfristen, Obligations)
- Shared versioning_utils.py Helper
- /{id}/versions Endpoints auf allen 5 Dokumenttypen
- Migration 037

Phase 4: Change-Request System
- Zentrale CR-Inbox mit CRUD + Accept/Reject/Edit Workflow
- Regelbasierte CR-Engine (VVT DPIA → DSFA CR, Datenkategorien → Loeschfristen CR)
- Audit-Trail
- Migration 038

Phase 5: Dokumentengenerierung
- 5 Template-Generatoren (DSFA, VVT, TOM, Loeschfristen, Obligations)
- Preview + Apply Endpoints (erzeugt CRs, keine direkten Dokumente)

Phase 6: Frontend-Integration
- Change-Request Inbox Page mit Stats, Filtern, Modals
- VersionHistory Timeline-Komponente
- SDKSidebar CR-Badge (60s Polling)
- Company Profile: 2 neue Wizard-Steps + "Dokumente generieren" CTA

Docs: 5 neue MkDocs-Seiten, CLAUDE.md aktualisiert
Tests: 97 neue Tests (alle bestanden)

Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
2026-03-07 14:12:34 +01:00

81 lines
2.4 KiB
Markdown

# Dokument-Versionierung
Alle Compliance-Dokumente (DSFA, VVT, TOM, Loeschfristen, Pflichten) werden automatisch versioniert. Jede Aenderung erzeugt eine neue Version mit Snapshot, Change-Summary und geaenderten Sektionen.
## Architektur
Das Versionierungs-Pattern folgt dem bestehenden `compliance_legal_document_versions`-Ansatz:
- Separate Versions-Tabelle pro Dokumenttyp
- Snapshot als JSONB (vollstaendiger Dokumentstand)
- Status-Workflow: draft → approved
- `current_version` Column auf der Haupt-Tabelle
## Unterstuetzte Dokumenttypen
| Typ | Versions-Tabelle | FK-Column |
|-----|-----------------|-----------|
| DSFA | `compliance_dsfa_versions` | `dsfa_id` |
| VVT | `compliance_vvt_activity_versions` | `activity_id` |
| TOM | `compliance_tom_versions` | `measure_id` |
| Loeschfristen | `compliance_loeschfristen_versions` | `policy_id` |
| Pflichten | `compliance_obligation_versions` | `obligation_id` |
## API-Endpoints
Fuer jeden Dokumenttyp gibt es zwei Versioning-Endpoints:
| Methode | Pfad | Beschreibung |
|---------|------|--------------|
| `GET` | `/{id}/versions` | Alle Versionen (neueste zuerst) |
| `GET` | `/{id}/versions/{v}` | Spezifische Version mit Snapshot |
### Beispiele
```
GET /api/compliance/dsfa/{dsfa_id}/versions
GET /api/compliance/dsfa/{dsfa_id}/versions/3
GET /api/compliance/activities/{id}/versions
GET /api/compliance/measures/{id}/versions
GET /api/compliance/loeschfristen/{id}/versions
GET /api/compliance/obligations/{id}/versions
```
## Shared Helper
`versioning_utils.py` stellt drei Funktionen bereit:
```python
create_version_snapshot(db, doc_type, doc_id, tenant_id, snapshot, change_summary, changed_sections, created_by)
list_versions(db, doc_type, doc_id, tenant_id)
get_version(db, doc_type, doc_id, tenant_id, version_number)
```
## Frontend-Komponente
Die `VersionHistory` React-Komponente zeigt eine Timeline aller Versionen:
```tsx
<VersionHistory
documentType="dsfa"
documentId={dsfa.id}
apiPath={`dsfa/${dsfa.id}/versions`}
/>
```
Features:
- Expandierbare Timeline mit Version-Dots
- Status-Badges (approved/draft)
- Datum und geaenderte Sektionen
- Change-Summary
## Datenbank
### Migration 037
Erstellt 5 Versions-Tabellen und fuegt `current_version INTEGER DEFAULT 0` zu allen Quell-Tabellen hinzu.
## Tests
- 20 Tests in `test_document_versions.py`
- VERSION_TABLES Mapping, create/list/get Version, Route-Registrierung