83 lines
2.2 KiB
Python
83 lines
2.2 KiB
Python
"""User API schemas for create, update, and read operations."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from uuid import UUID
|
|
|
|
from pydantic import Field
|
|
from sqlmodel import SQLModel
|
|
|
|
RUNTIME_ANNOTATION_TYPES = (UUID,)
|
|
|
|
|
|
class UserBase(SQLModel):
|
|
"""Common user profile fields shared across user payload schemas."""
|
|
|
|
clerk_user_id: str = Field(
|
|
description="External auth provider user identifier (Clerk).",
|
|
examples=["user_2abcXYZ"],
|
|
)
|
|
email: str | None = Field(
|
|
default=None,
|
|
description="Primary email address for the user.",
|
|
examples=["alex@example.com"],
|
|
)
|
|
name: str | None = Field(
|
|
default=None,
|
|
description="Full display name.",
|
|
examples=["Alex Chen"],
|
|
)
|
|
preferred_name: str | None = Field(
|
|
default=None,
|
|
description="Preferred short name used in UI.",
|
|
examples=["Alex"],
|
|
)
|
|
pronouns: str | None = Field(
|
|
default=None,
|
|
description="Preferred pronouns.",
|
|
examples=["they/them"],
|
|
)
|
|
timezone: str | None = Field(
|
|
default=None,
|
|
description="IANA timezone identifier.",
|
|
examples=["America/Los_Angeles"],
|
|
)
|
|
notes: str | None = Field(
|
|
default=None,
|
|
description="Internal notes for operators.",
|
|
examples=["Primary operator for board triage."],
|
|
)
|
|
context: str | None = Field(
|
|
default=None,
|
|
description="Additional context used by the system for personalization.",
|
|
examples=["Handles incident coordination and escalation."],
|
|
)
|
|
|
|
|
|
class UserCreate(UserBase):
|
|
"""Payload used to create a user record."""
|
|
|
|
|
|
class UserUpdate(SQLModel):
|
|
"""Payload for partial user profile updates."""
|
|
|
|
name: str | None = None
|
|
preferred_name: str | None = None
|
|
pronouns: str | None = None
|
|
timezone: str | None = None
|
|
notes: str | None = None
|
|
context: str | None = None
|
|
|
|
|
|
class UserRead(UserBase):
|
|
"""Full user payload returned by API responses."""
|
|
|
|
id: UUID = Field(
|
|
description="Internal user UUID.",
|
|
examples=["11111111-1111-1111-1111-111111111111"],
|
|
)
|
|
is_super_admin: bool = Field(
|
|
description="Whether this user has tenant-wide super-admin privileges.",
|
|
examples=[False],
|
|
)
|