Skip to content

docs: optional file input type annotation using Optional #1551

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

docs: optional file input type annotation using Optional #1551

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 2 additions & 4 deletions docs/docs/guides/input/file-params.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ def create_user(request, details: UserDetails, file: File[UploadedFile]):
```

this will expect from the client side to send data as `multipart/form-data with 2 fields:

- details: JSON as string
- file: file

Expand All @@ -96,7 +96,7 @@ If you would like the file input to be optional, all that you have to do is to p

```python
@api.post('/users')
def create_user(request, details: Form[UserDetails], avatar: File[UploadedFile] = None):
def create_user(request, details: Form[UserDetails], avatar: Optional[File[UploadedFile]] = None):
user = add_user_to_database(details)
if avatar is not None:
set_user_avatar(user)
Expand Down Expand Up @@ -141,5 +141,3 @@ When Django Ninja detects a PUT or PATCH etc methods with multipart/form-data a


Note: This middleware does not interfere with normal POST behavior or any other methods.