d9dcfb97ef
Phase 1 Step 3 of PHASE1_RUNBOOK.md. compliance/api/schemas.py is
decomposed into 16 per-domain Pydantic schema modules under
compliance/schemas/:
common.py ( 79) — 6 API enums + PaginationMeta
regulation.py ( 52)
requirement.py ( 80)
control.py (119) — Control + Mapping
evidence.py ( 66)
risk.py ( 79)
ai_system.py ( 63)
dashboard.py (195) — Dashboard, Export, Executive Dashboard
service_module.py (121)
bsi.py ( 58) — BSI + PDF extraction
audit_session.py (172)
report.py ( 53)
isms_governance.py (343) — Scope, Context, Policy, Objective, SoA
isms_audit.py (431) — Finding, CAPA, Review, Internal Audit, Readiness, Trail, ISO27001
vvt.py (168)
tom.py ( 71)
compliance/api/schemas.py becomes a 39-line re-export shim so existing
imports (from compliance.api.schemas import RegulationResponse) keep
working unchanged. New code should import from the domain module
directly (from compliance.schemas.regulation import RegulationResponse).
Deferred-from-sweep: all 28 class Config blocks in the original file
were converted to model_config = ConfigDict(...) during the split.
schemas.py-sourced PydanticDeprecatedSince20 warnings are now gone.
Cross-domain references handled via targeted imports (e.g. dashboard.py
imports EvidenceResponse from evidence, RiskResponse from risk). common
API enums + PaginationMeta are imported by every domain module.
Verified:
- 173/173 pytest compliance/tests/ tests/contracts/ pass
- OpenAPI 360 paths / 484 operations unchanged (contract test green)
- All new files under the 500-line hard cap (largest: isms_audit.py
at 431, isms_governance.py at 343, dashboard.py at 195)
- No file in compliance/schemas/ or compliance/api/schemas.py
exceeds the hard cap
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
122 lines
3.6 KiB
Python
122 lines
3.6 KiB
Python
"""
|
|
Service Module Pydantic schemas — extracted from compliance/api/schemas.py.
|
|
|
|
Phase 1 Step 3: the monolithic ``compliance.api.schemas`` module is being
|
|
split per domain under ``compliance.schemas``. This module is re-exported
|
|
from ``compliance.api.schemas`` for backwards compatibility.
|
|
"""
|
|
|
|
from datetime import datetime, date
|
|
from typing import Optional, List, Any, Dict
|
|
|
|
from pydantic import BaseModel, ConfigDict, Field
|
|
|
|
from compliance.schemas.common import (
|
|
PaginationMeta, RegulationType, ControlType, ControlDomain,
|
|
ControlStatus, RiskLevel, EvidenceStatus,
|
|
)
|
|
|
|
|
|
# ============================================================================
|
|
# Service Module Schemas (Sprint 3)
|
|
# ============================================================================
|
|
|
|
class ServiceModuleBase(BaseModel):
|
|
"""Base schema for service modules."""
|
|
name: str
|
|
display_name: str
|
|
description: Optional[str] = None
|
|
service_type: str
|
|
port: Optional[int] = None
|
|
technology_stack: Optional[List[str]] = None
|
|
repository_path: Optional[str] = None
|
|
docker_image: Optional[str] = None
|
|
data_categories: Optional[List[str]] = None
|
|
processes_pii: bool = False
|
|
processes_health_data: bool = False
|
|
ai_components: bool = False
|
|
criticality: str = "medium"
|
|
owner_team: Optional[str] = None
|
|
owner_contact: Optional[str] = None
|
|
|
|
|
|
class ServiceModuleCreate(ServiceModuleBase):
|
|
"""Schema for creating a service module."""
|
|
pass
|
|
|
|
|
|
class ServiceModuleResponse(ServiceModuleBase):
|
|
"""Response schema for service module."""
|
|
id: str
|
|
is_active: bool
|
|
compliance_score: Optional[float] = None
|
|
last_compliance_check: Optional[datetime] = None
|
|
created_at: datetime
|
|
updated_at: datetime
|
|
regulation_count: Optional[int] = None
|
|
risk_count: Optional[int] = None
|
|
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
|
|
class ServiceModuleListResponse(BaseModel):
|
|
"""List response for service modules."""
|
|
modules: List[ServiceModuleResponse]
|
|
total: int
|
|
|
|
|
|
class ServiceModuleDetailResponse(ServiceModuleResponse):
|
|
"""Detailed response including regulations and risks."""
|
|
regulations: Optional[List[Dict[str, Any]]] = None
|
|
risks: Optional[List[Dict[str, Any]]] = None
|
|
|
|
|
|
class ModuleRegulationMappingBase(BaseModel):
|
|
"""Base schema for module-regulation mapping."""
|
|
module_id: str
|
|
regulation_id: str
|
|
relevance_level: str = "medium"
|
|
notes: Optional[str] = None
|
|
applicable_articles: Optional[List[str]] = None
|
|
|
|
|
|
class ModuleRegulationMappingCreate(ModuleRegulationMappingBase):
|
|
"""Schema for creating a module-regulation mapping."""
|
|
pass
|
|
|
|
|
|
class ModuleRegulationMappingResponse(ModuleRegulationMappingBase):
|
|
"""Response schema for module-regulation mapping."""
|
|
id: str
|
|
module_name: Optional[str] = None
|
|
regulation_code: Optional[str] = None
|
|
regulation_name: Optional[str] = None
|
|
created_at: datetime
|
|
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
|
|
class ModuleSeedRequest(BaseModel):
|
|
"""Request to seed service modules."""
|
|
force: bool = False
|
|
|
|
|
|
class ModuleSeedResponse(BaseModel):
|
|
"""Response from seeding service modules."""
|
|
success: bool
|
|
message: str
|
|
modules_created: int
|
|
mappings_created: int
|
|
|
|
|
|
class ModuleComplianceOverview(BaseModel):
|
|
"""Overview of compliance status for all modules."""
|
|
total_modules: int
|
|
modules_by_type: Dict[str, int]
|
|
modules_by_criticality: Dict[str, int]
|
|
modules_processing_pii: int
|
|
modules_with_ai: int
|
|
average_compliance_score: Optional[float] = None
|
|
regulations_coverage: Dict[str, int] # regulation_code -> module_count
|
|
|