d3vyce/fastapi-toolsets
1
0
Fork 0
mirror of https://github.com/d3vyce/fastapi-toolsets.git synced 2026-03-01 17:00:48 +01:00
Code Issues Packages Projects Releases Wiki Activity

Add examples in documentations (#99)

Browse Source 
* docs: fix crud

* docs: update README features

* docs: add pagination/search example

* docs: update zensical.toml

* docs: cleanup

* docs: update status to Stable + update description

* docs: add example run commands
This commit is contained in:
d3vyce
2026-02-27 19:56:09 +01:00
committed by GitHub
parent 8d57bf9525
commit d7ad7308c5
16 changed files with 588 additions and 268 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/module/crud.md
View File

@@ -170,7 +170,7 @@ PostCrud = CrudFactory(model=Post, cursor_column=Post.created_at)
Two search strategies are available, both compatible with [`offset_paginate`](../reference/crud.md#fastapi_toolsets.crud.factory.AsyncCrud.offset_paginate) and [`cursor_paginate`](../reference/crud.md#fastapi_toolsets.crud.factory.AsyncCrud.cursor_paginate).
| | Full-text search | Filter attributes |
| | Full-text search | Faceted search |
|---|---|---|
| Input | Free-text string | Exact column values |
| Relationship support | Yes | Yes |
@@ -242,7 +242,7 @@ async def get_users(
)
```
### Filter attributes
### Faceted search
!!! info "Added in `v1.2`"
@@ -384,7 +384,7 @@ await UserCrud.upsert(
)
```
## `schema` — typed response serialization
## Response serialization
!!! info "Added in `v1.1`"