Files
breakpilot-compliance/backend-compliance/compliance/schemas/template_rule.py
T
Benjamin Admin bb183b0e75
CI / detect-changes (push) Successful in 12s
CI / branch-name (push) Has been skipped
CI / test-python-backend (push) Successful in 33s
CI / test-python-document-crawler (push) Successful in 23s
CI / test-python-dsms-gateway (push) Successful in 19s
CI / guardrail-integrity (push) Has been skipped
CI / secret-scan (push) Has been skipped
CI / dep-audit (push) Has been skipped
CI / sbom-scan (push) Has been skipped
CI / build-sha-integrity (push) Failing after 7s
CI / validate-canonical-controls (push) Successful in 16s
CI / loc-budget (push) Failing after 18s
CI / go-lint (push) Has been skipped
CI / python-lint (push) Has been skipped
CI / nodejs-lint (push) Has been skipped
CI / nodejs-build (push) Successful in 2m27s
CI / test-go (push) Failing after 46s
CI / iace-gt-coverage (push) Successful in 25s
feat(template-rules): backend foundation for profile-based document recommendations
Introduces the sustainable backend replacement for the hardcoded inline rules in
admin-compliance/app/sdk/document-generator/templateRecommendations.ts.

What's in this commit (Phase 1.1 - 1.5 of the rustling-yawning-boot plan):

- Migration 147: 4 new tables
  - compliance_template_rules (rule shell, document_type, current_version_id)
  - compliance_template_rule_versions (lifecycle, JSONB conditions,
    source_citation, change_summary, approval timestamps)
  - compliance_template_rule_approvals (audit trail)
  - compliance_tenant_rule_overrides (per-tenant classification overrides)
  Plus partial unique index for "only one is_live=1 version per rule".

- SQLAlchemy models: TemplateRuleDB, TemplateRuleVersionDB,
  TemplateRuleApprovalDB, TenantRuleOverrideDB (compliance/db/).

- Pydantic schemas (compliance/schemas/template_rule.py): full request/response
  set including RecommendationRequest/Result with reasons and override tracking.

- TemplateRuleService (compliance/services/): CRUD + Lifecycle transitions
  (submit_for_review/approve/publish/reject) following legal_document_service.py
  pattern with _transition() helper and approval audit trail. Plus tenant
  override upsert.

- RecommendationService: condition evaluator (eq, neq, in, not_in, gte/lte/gt/lt,
  exists, truthy) over JSONB conditions, override application, reason generation
  for human-readable explanations in workspace UI.

- 18 FastAPI routes in compliance/api/template_rule_routes.py covering rule CRUD,
  version lifecycle, override management and POST /recommend evaluation endpoint.

- Seed data: 33 initial rules ported from templateRecommendations.ts in
  compliance/data/template_rule_seed_data.py, written as published versions
  on first seed run. Idempotent via rule_key.

Phase 1.6 (pytest suite) and Phase 2 (editorial UI in admin-compliance) follow
in separate commits.

[migration-approved]

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
2026-06-06 23:13:50 +02:00

175 lines
4.4 KiB
Python

"""
Pydantic schemas for Compliance Template Rules — profilbasierte Empfehlungs-Regeln
mit Versionierung, Approval-Workflow und Tenant-Overrides.
"""
from datetime import datetime
from typing import Any, Optional
from pydantic import BaseModel, Field
# ----- Bedingungs-Strukturen -----
class RuleClause(BaseModel):
"""Eine einzelne Klausel innerhalb einer Bedingung."""
field: str
op: str # "eq" | "neq" | "gte" | "lte" | "gt" | "lt" | "in" | "not_in" | "exists"
value: Any = None
class RuleCondition(BaseModel):
"""Strukturierte Bedingung — kombiniert mehrere Klauseln per AND ('all') oder OR ('any')."""
kind: str = "all" # "all" oder "any"
clauses: list[RuleClause] = Field(default_factory=list)
# ----- Rule (Hülle) -----
class RuleCreate(BaseModel):
rule_key: str
document_type: str
title: str
class RuleResponse(BaseModel):
id: str
rule_key: str
document_type: str
title: str
current_version_id: Optional[str]
created_at: datetime
updated_at: Optional[datetime]
# ----- Version -----
class RuleVersionCreate(BaseModel):
"""Neuer Draft (entweder ganz neu oder fork einer Live-Version)."""
rule_id: str
classification: str # required | recommended | optional
conditions: RuleCondition
source_citation: str
rationale: Optional[str] = None
created_by: Optional[str] = None
class RuleVersionUpdate(BaseModel):
"""Edit eines Drafts — nur erlaubt während status='draft'."""
classification: Optional[str] = None
conditions: Optional[RuleCondition] = None
source_citation: Optional[str] = None
rationale: Optional[str] = None
change_summary: Optional[str] = None
class RuleVersionResponse(BaseModel):
id: str
rule_id: str
version_number: int
status: str
is_live: bool
classification: str
conditions: dict[str, Any]
source_citation: str
rationale: Optional[str]
change_summary: Optional[str]
created_by: Optional[str]
submitted_by: Optional[str]
submitted_at: Optional[datetime]
approved_by: Optional[str]
approved_at: Optional[datetime]
published_by: Optional[str]
published_at: Optional[datetime]
rejected_by: Optional[str]
rejected_at: Optional[datetime]
rejection_reason: Optional[str]
created_at: datetime
updated_at: Optional[datetime]
# ----- Lifecycle-Actions -----
class SubmitForReviewRequest(BaseModel):
change_summary: str
submitter: Optional[str] = None
comment: Optional[str] = None
class ApprovalActionRequest(BaseModel):
approver: Optional[str] = None
comment: Optional[str] = None
class RejectActionRequest(BaseModel):
rejector: Optional[str] = None
rejection_reason: str
comment: Optional[str] = None
class ApprovalHistoryEntry(BaseModel):
id: str
version_id: str
action: str
approver: Optional[str]
comment: Optional[str]
created_at: datetime
# ----- Tenant-Overrides -----
class OverrideCreate(BaseModel):
rule_id: str
override_classification: Optional[str] = None # null = deaktiviert
reason: str
created_by: Optional[str] = None
class OverrideResponse(BaseModel):
id: str
tenant_id: str
rule_id: str
override_classification: Optional[str]
reason: str
created_by: Optional[str]
created_at: datetime
updated_at: Optional[datetime]
# ----- Recommendation -----
class RecommendationRequest(BaseModel):
"""Input fürs Recommend: Profil-Antworten + optional Compliance-Tiefe."""
profile: dict[str, Any]
compliance_depth_level: Optional[str] = None # "L1"|"L2"|"L3"|"L4"
class RecommendedItem(BaseModel):
document_type: str
title: str
rule_id: str
rule_key: str
classification: str # required | recommended | optional (nach Override-Anwendung)
base_classification: str # ohne Override
source_citation: str
reason: str # menschenlesbare Begründung
override_applied: bool
class RecommendationResult(BaseModel):
required: list[RecommendedItem]
recommended: list[RecommendedItem]
optional: list[RecommendedItem]
profile_used: dict[str, Any]
__all__ = [
"RuleClause", "RuleCondition",
"RuleCreate", "RuleResponse",
"RuleVersionCreate", "RuleVersionUpdate", "RuleVersionResponse",
"SubmitForReviewRequest", "ApprovalActionRequest", "RejectActionRequest",
"ApprovalHistoryEntry",
"OverrideCreate", "OverrideResponse",
"RecommendationRequest", "RecommendedItem", "RecommendationResult",
]