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:
20
docs/reference/crud.md
Normal file
20
docs/reference/crud.md
Normal file
@@ -0,0 +1,20 @@
|
||||
# `crud`
|
||||
|
||||
Here's the reference for the CRUD classes, factory, and search utilities.
|
||||
|
||||
You can import the main symbols from `fastapi_toolsets.crud`:
|
||||
|
||||
```python
|
||||
from fastapi_toolsets.crud import CrudFactory, AsyncCrud
|
||||
from fastapi_toolsets.crud.search import SearchConfig, get_searchable_fields, build_search_filters
|
||||
```
|
||||
|
||||
## ::: fastapi_toolsets.crud.factory.AsyncCrud
|
||||
|
||||
## ::: fastapi_toolsets.crud.factory.CrudFactory
|
||||
|
||||
## ::: fastapi_toolsets.crud.search.SearchConfig
|
||||
|
||||
## ::: fastapi_toolsets.crud.search.get_searchable_fields
|
||||
|
||||
## ::: fastapi_toolsets.crud.search.build_search_filters
|
||||
Reference in New Issue
Block a user