Skip to content

Commit 39f40b3

Browse files
committed
files documentation to latest
1 parent f91e321 commit 39f40b3

File tree

3 files changed

+7
-7
lines changed

3 files changed

+7
-7
lines changed

docs/docs/guides/input/file-params.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ from ninja import NinjaAPI, File
77
from ninja.files import UploadedFile
88

99
@api.post("/upload")
10-
def upload(request, file: UploadedFile = File(...)):
10+
def upload(request, file: File[UploadedFile]):
1111
data = file.read()
1212
return {'name': file.name, 'len': len(data)}
1313
```
@@ -36,7 +36,7 @@ from ninja import NinjaAPI, File
3636
from ninja.files import UploadedFile
3737

3838
@api.post("/upload-many")
39-
def upload_many(request, files: List[UploadedFile] = File(...)):
39+
def upload_many(request, files: File[List[UploadedFile]]):
4040
return [f.name for f in files]
4141
```
4242

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

9797
```python
9898
@api.post('/users')
99-
def create_user(request, details: Form[UserDetails], avatar: UploadedFile = File(None)):
99+
def create_user(request, details: Form[UserDetails], avatar: File[UploadedFile] = None):
100100
user = add_user_to_database(details)
101101
if avatar is not None:
102102
set_user_avatar(user)

docs/docs/tutorial/other/crud.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ See the recipe below for handling the file upload (when using Django models):
5959
from ninja import UploadedFile, File
6060

6161
@api.post("/employees")
62-
def create_employee(request, payload: EmployeeIn, cv: UploadedFile = File(...)):
62+
def create_employee(request, payload: EmployeeIn, cv: File[UploadedFile]):
6363
payload_dict = payload.dict()
6464
employee = Employee(**payload_dict)
6565
employee.cv.save(cv.name, cv) # will save model instance as well
@@ -75,7 +75,7 @@ from ninja import UploadedFile, File
7575
STORAGE = FileSystemStorage()
7676

7777
@api.post("/upload")
78-
def create_upload(request, cv: UploadedFile = File(...)):
78+
def create_upload(request, cv: File[UploadedFile]):
7979
filename = STORAGE.save(cv.name, cv)
8080
# Handle things further
8181
```

tests/demo_project/multi_param/api.py

+2-2
Original file line numberDiff line numberDiff line change
@@ -177,7 +177,7 @@ def test_multi_form_body(
177177
@router.post("/test-multi-body-form-file", response=ResponseData, by_alias=True)
178178
def test_multi_body_form_file(
179179
request,
180-
file: UploadedFile = File(...),
180+
file: File[UploadedFile],
181181
i: int = Body(...),
182182
s: str = Form("a-str"),
183183
data: TestData4 = Body(..., **test_data4_extra),
@@ -189,7 +189,7 @@ def test_multi_body_form_file(
189189
@router.post("/test-multi-form-body-file", response=ResponseData, by_alias=True)
190190
def test_multi_form_body_file(
191191
request,
192-
file: UploadedFile = File(...),
192+
file: File[UploadedFile],
193193
i: int = Form(...),
194194
s: str = Body("a-str"),
195195
data: TestData4 = Form(..., **test_data4_extra),

0 commit comments

Comments
 (0)