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>
81 lines
2.3 KiB
Python
81 lines
2.3 KiB
Python
"""
|
|
Requirement 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,
|
|
)
|
|
|
|
|
|
# ============================================================================
|
|
# Requirement Schemas
|
|
# ============================================================================
|
|
|
|
class RequirementBase(BaseModel):
|
|
article: str
|
|
paragraph: Optional[str] = None
|
|
title: str
|
|
description: Optional[str] = None
|
|
requirement_text: Optional[str] = None
|
|
breakpilot_interpretation: Optional[str] = None
|
|
is_applicable: bool = True
|
|
applicability_reason: Optional[str] = None
|
|
priority: int = 2
|
|
|
|
|
|
class RequirementCreate(RequirementBase):
|
|
regulation_id: str
|
|
|
|
|
|
class RequirementResponse(RequirementBase):
|
|
id: str
|
|
regulation_id: str
|
|
regulation_code: Optional[str] = None
|
|
|
|
# Implementation tracking
|
|
implementation_status: Optional[str] = "not_started"
|
|
implementation_details: Optional[str] = None
|
|
code_references: Optional[List[Dict[str, Any]]] = None
|
|
documentation_links: Optional[List[str]] = None
|
|
|
|
# Evidence for auditors
|
|
evidence_description: Optional[str] = None
|
|
evidence_artifacts: Optional[List[Dict[str, Any]]] = None
|
|
|
|
# Audit tracking
|
|
auditor_notes: Optional[str] = None
|
|
audit_status: Optional[str] = "pending"
|
|
last_audit_date: Optional[datetime] = None
|
|
last_auditor: Optional[str] = None
|
|
|
|
# Source reference
|
|
source_page: Optional[int] = None
|
|
source_section: Optional[str] = None
|
|
|
|
created_at: datetime
|
|
updated_at: datetime
|
|
|
|
model_config = ConfigDict(from_attributes=True)
|
|
|
|
|
|
class RequirementListResponse(BaseModel):
|
|
requirements: List[RequirementResponse]
|
|
total: int
|
|
|
|
|
|
class PaginatedRequirementResponse(BaseModel):
|
|
"""Paginated response for requirements - optimized for large datasets."""
|
|
data: List[RequirementResponse]
|
|
pagination: PaginationMeta
|
|
|