Pydantic Models Py

1---
2name: pydantic-models-py
3description: Create Pydantic models following the multi-model pattern with Base, Create, Update, Response, and InDB variants. Use when defining API request/response schemas, database models, or data validation in Python applications using Pydantic v2.
4---
5 
6# Pydantic Models
7 
8Create Pydantic models following the multi-model pattern for clean API contracts.
9 
10## Quick Start
11 
12Copy the template from [assets/template.py](assets/template.py) and replace placeholders:
13- `{{ResourceName}}` → PascalCase name (e.g., `Project`)
14- `{{resource_name}}` → snake_case name (e.g., `project`)
15 
16## Multi-Model Pattern
17 
18| Model | Purpose |
19|-------|---------|
20| `Base` | Common fields shared across models |
21| `Create` | Request body for creation (required fields) |
22| `Update` | Request body for updates (all optional) |
23| `Response` | API response with all fields |
24| `InDB` | Database document with `doc_type` |
25 
26## camelCase Aliases
27 
28```python
29class MyModel(BaseModel):
30    workspace_id: str = Field(..., alias="workspaceId")
31    created_at: datetime = Field(..., alias="createdAt")
32    
33    class Config:
34        populate_by_name = True  # Accept both snake_case and camelCase
35```
36 
37## Optional Update Fields
38 
39```python
40class MyUpdate(BaseModel):
41    """All fields optional for PATCH requests."""
42    name: Optional[str] = Field(None, min_length=1)
43    description: Optional[str] = None
44```
45 
46## Database Document
47 
48```python
49class MyInDB(MyResponse):
50    """Adds doc_type for Cosmos DB queries."""
51    doc_type: str = "my_resource"
52```
53 
54## Integration Steps
55 
561. Create models in `src/backend/app/models/`
572. Export from `src/backend/app/models/__init__.py`
583. Add corresponding TypeScript types
59