Skip to content

Commit fbd3237

Browse files
committed
update pagination doc
1 parent 438ab99 commit fbd3237

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

docs/tutorial/pagination.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,17 @@
99
- func_or_pgn_class: Defines a route function or a Pagination Class. default: `ninja_extra.pagination.LimitOffsetPagination`
1010
- paginator_params: extra parameters for initialising Pagination Class
1111

12+
!!! info
13+
When using `ninja_extra.pagination.LimitOffsetPagination`, you should use `NinjaPaginationResponseSchema` as pagination response schema wrapper
14+
eg:
15+
```python
16+
17+
@route.get('', response=NinjaPaginationResponseSchema[UserSchema])
18+
@paginate()
19+
def list_items(self):
20+
return item_model.objects.all()
21+
```
22+
1223
### Changing Default Pagination Class
1324
To change the default pagination class, you need to add a `NINJA_EXTRA` variable in `settings.py` with a key `PAGINATION_CLASS` and value defining path to pagination class
1425
```python

0 commit comments

Comments
 (0)