Files
fastapi-toolsets/docs/reference/schemas.md

1.0 KiB

schemas

Here's the reference for all response models and types provided by the schemas module.

You can import them directly from fastapi_toolsets.schemas:

from fastapi_toolsets.schemas import (
    PydanticBase,
    ResponseStatus,
    ApiError,
    BaseResponse,
    Response,
    ErrorResponse,
    OffsetPagination,
    CursorPagination,
    PaginationType,
    PaginatedResponse,
    OffsetPaginatedResponse,
    CursorPaginatedResponse,
)

::: fastapi_toolsets.schemas.PydanticBase

::: fastapi_toolsets.schemas.ResponseStatus

::: fastapi_toolsets.schemas.ApiError

::: fastapi_toolsets.schemas.BaseResponse

::: fastapi_toolsets.schemas.Response

::: fastapi_toolsets.schemas.ErrorResponse

::: fastapi_toolsets.schemas.OffsetPagination

::: fastapi_toolsets.schemas.CursorPagination

::: fastapi_toolsets.schemas.PaginationType

::: fastapi_toolsets.schemas.PaginatedResponse

::: fastapi_toolsets.schemas.OffsetPaginatedResponse

::: fastapi_toolsets.schemas.CursorPaginatedResponse