Skip to content

Commit ff705d8

Browse files
committed
update docstrings for upload function
1 parent 6ee9d6f commit ff705d8

File tree

1 file changed

+10
-2
lines changed

1 file changed

+10
-2
lines changed

videodb/_upload.py

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,8 +32,16 @@ def upload(
3232
) -> dict:
3333
"""Upload a file or URL.
3434
35-
``source`` can be used as a generic argument which accepts either a local
36-
file path or a URL.
35+
:param _connection: Connection object for API calls
36+
:param str source: Local path or URL of the file to be uploaded
37+
:param str media_type: MediaType object (optional)
38+
:param str name: Name of the file (optional)
39+
:param str description: Description of the file (optional)
40+
:param str callback_url: URL to receive the callback (optional)
41+
:param str file_path: Path to the file to be uploaded
42+
:param str url: URL of the file to be uploaded
43+
:return: Dictionary containing upload response data
44+
:rtype: dict
3745
"""
3846
if source and (file_path or url):
3947
raise VideodbError("source cannot be used with file_path or url")

0 commit comments

Comments
 (0)