mirror of
https://github.com/d3vyce/fastapi-toolsets.git
synced 2026-03-02 01:10:47 +01:00
chore: documentation (#76)
* chore: update docstring example to use python code block * docs: add documentation * feat: add docs build + fix other workdlows * fix: add missing return type
This commit is contained in:
34
docs/reference/schemas.md
Normal file
34
docs/reference/schemas.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# `schemas` module
|
||||
|
||||
Here's the reference for all response models and types provided by the `schemas` module.
|
||||
|
||||
You can import them directly from `fastapi_toolsets.schemas`:
|
||||
|
||||
```python
|
||||
from fastapi_toolsets.schemas import (
|
||||
PydanticBase,
|
||||
ResponseStatus,
|
||||
ApiError,
|
||||
BaseResponse,
|
||||
Response,
|
||||
ErrorResponse,
|
||||
Pagination,
|
||||
PaginatedResponse,
|
||||
)
|
||||
```
|
||||
|
||||
## ::: 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.Pagination
|
||||
|
||||
## ::: fastapi_toolsets.schemas.PaginatedResponse
|
||||
Reference in New Issue
Block a user