Skip to content

Commit

Permalink
chores(): updated doc to address #96 issue
Browse files Browse the repository at this point in the history
  • Loading branch information
eadwinCode committed Dec 2, 2023
1 parent 3838014 commit 20ff89b
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 10 deletions.
3 changes: 3 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -34,3 +34,6 @@ test-cov:clean ## Run tests with coverage

doc-deploy:clean ## Run Deploy Documentation
mkdocs gh-deploy --force

doc-serve: ## Launch doc local server
mkdocs serve
25 changes: 15 additions & 10 deletions docs/tutorial/pagination.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,18 +9,23 @@
- func_or_pgn_class: Defines a route function or a Pagination Class. default: `ninja_extra.pagination.LimitOffsetPagination`
- paginator_params: extra parameters for initialising Pagination Class

!!! info
When using `ninja_extra.pagination.LimitOffsetPagination`, you should use `NinjaPaginationResponseSchema` as pagination response schema wrapper
eg:
```python
### **Using Ninja LimitOffsetPagination**
When using `ninja_extra.pagination.LimitOffsetPagination`,
you should use `NinjaPaginationResponseSchema` as pagination response schema wrapper.
For example:
```python
from ninja_extra.schemas import NinjaPaginationResponseSchema

...

@route.get('', response=NinjaPaginationResponseSchema[UserSchema])
@paginate()
def list_items(self):
return item_model.objects.all()
```

@route.get('', response=NinjaPaginationResponseSchema[UserSchema])
@paginate()
def list_items(self):
return item_model.objects.all()
```

### Changing Default Pagination Class
### **Changing Default Pagination Class**
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
```python
# Django project settings.py
Expand Down

0 comments on commit 20ff89b

Please sign in to comment.