mirror of
https://github.com/d3vyce/fastapi-toolsets.git
synced 2026-03-01 17:00:48 +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/exceptions.md
Normal file
34
docs/reference/exceptions.md
Normal file
@@ -0,0 +1,34 @@
|
||||
# `exceptions`
|
||||
|
||||
Here's the reference for all exception classes and handler utilities.
|
||||
|
||||
You can import them directly from `fastapi_toolsets.exceptions`:
|
||||
|
||||
```python
|
||||
from fastapi_toolsets.exceptions import (
|
||||
ApiException,
|
||||
UnauthorizedError,
|
||||
ForbiddenError,
|
||||
NotFoundError,
|
||||
ConflictError,
|
||||
NoSearchableFieldsError,
|
||||
generate_error_responses,
|
||||
init_exceptions_handlers,
|
||||
)
|
||||
```
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.ApiException
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.UnauthorizedError
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.ForbiddenError
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.NotFoundError
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.ConflictError
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.NoSearchableFieldsError
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.exceptions.generate_error_responses
|
||||
|
||||
## ::: fastapi_toolsets.exceptions.handler.init_exceptions_handlers
|
||||
Reference in New Issue
Block a user