fastapi_tools.schemas.common

Common Pydantic schemas shared across the webapp.

Classes:

• ErrorResponse –

  Standard error response.

• HealthResponse –

  Health check response.

• MessageResponse –

  Simple message response.

• PaginatedResponse –

  Paginated response wrapper.

• PaginationParams –

  Pagination query parameters.

• ReadinessResponse –

  Readiness probe response.

ErrorResponse

Bases: BaseModel

Standard error response.

HealthResponse

Bases: BaseModel

Health check response.

MessageResponse

Bases: BaseModel

Simple message response.

PaginatedResponse

Bases: BaseModel

Paginated response wrapper.

Methods:

• calculate_pages –

  Calculate total number of pages.

calculate_pages classmethod

calculate_pages(total: int, page_size: int) -> int

Calculate total number of pages.

Source code in src/fastapi_tools/schemas/common.py

@classmethod
def calculate_pages(cls, total: int, page_size: int) -> int:
    """Calculate total number of pages."""
    return (total + page_size - 1) // page_size if total > 0 else 0

PaginationParams

Bases: BaseModel

Pagination query parameters.

Attributes:

• offset (int) –

  Calculate the offset for database queries.

offset property

offset: int

Calculate the offset for database queries.

ReadinessResponse

Bases: BaseModel

Readiness probe response.