pydantic_response_models.responses

Common API response DTOs.

Attributes

T

Classes

SuccessResponse

Generic success response wrapper.

ErrorDetail

Error detail model.

ErrorResponse

Standard error response.

PaginatedResponse

Paginated response wrapper.

MessageResponse

Simple message response.

Module Contents

pydantic_response_models.responses.T
class pydantic_response_models.responses.SuccessResponse

Bases: pydantic.BaseModel, Generic[T]

Generic success response wrapper.

success: bool = True
data: T
message: str | None = None
class pydantic_response_models.responses.ErrorDetail

Bases: pydantic.BaseModel

Error detail model.

field: str | None
message: str
code: str | None
class pydantic_response_models.responses.ErrorResponse

Bases: pydantic.BaseModel

Standard error response.

success: bool = False
error: str
details: List[ErrorDetail] | None
code: str | None
class pydantic_response_models.responses.PaginatedResponse

Bases: pydantic.BaseModel, Generic[T]

Paginated response wrapper.

items: List[T]
total: int
page: int
page_size: int
pages: int
class pydantic_response_models.responses.MessageResponse

Bases: pydantic.BaseModel

Simple message response.

message: str
success: bool = True