Phase 5.14: API documentation - OpenAPI tags, response models, examples, docs

app/schemas/auth.py

@@ -6,8 +6,8 @@ from pydantic import BaseModel, EmailStr, Field
 
 
 class LoginRequest(BaseModel):
-    email: EmailStr
-    password: str = Field(..., min_length=1)
+    email: EmailStr = Field(..., examples=["admin@leocrm.local"])
+    password: str = Field(..., min_length=1, examples=["secure-password"])
 
 
 class PasswordResetRequest(BaseModel):
@@ -24,12 +24,12 @@ class SwitchTenantRequest(BaseModel):
 
 
 class AuthResponse(BaseModel):
-    user_id: str
-    email: str
-    name: str
-    role: str
-    tenant_id: str
-    tenant_name: str | None = None
+    user_id: str = Field(..., examples=["550e8400-e29b-41d4-a716-446655440000"])
+    email: str = Field(..., examples=["admin@leocrm.local"])
+    name: str = Field(..., examples=["Admin User"])
+    role: str = Field(..., examples=["admin"])
+    tenant_id: str = Field(..., examples=["550e8400-e29b-41d4-a716-446655440001"])
+    tenant_name: str | None = Field(None, examples=["Acme GmbH"])
 
 
 class MessageResponse(BaseModel):

app/schemas/user.py

@@ -6,11 +6,11 @@ from pydantic import BaseModel, EmailStr, Field
 
 
 class UserCreate(BaseModel):
-    email: EmailStr
-    name: str = Field(..., min_length=1, max_length=200)
-    password: str = Field(..., min_length=8)
-    role: str = Field(default="viewer")
-    role_id: str | None = Field(default=None, description="UUID of a custom Role")
+    email: EmailStr = Field(..., examples=["user@leocrm.local"])
+    name: str = Field(..., min_length=1, max_length=200, examples=["John Doe"])
+    password: str = Field(..., min_length=8, examples=["secure-password"])
+    role: str = Field(default="viewer", examples=["viewer"])
+    role_id: str | None = Field(default=None, description="UUID of a custom Role", examples=["550e8400-e29b-41d4-a716-446655440000"])
     is_active: bool = True