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

2026-07-23 22:44:54 +02:00
parent 3c1b2f227b
commit 66b6c32ed8
11 changed files with 716 additions and 28 deletions
@@ -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):