Skip to content

Commit 842b620

Browse files
committed
update public api
1 parent 67c41d2 commit 842b620

2 files changed

Lines changed: 32 additions & 5 deletions

File tree

ayon_api/__init__.py

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -74,6 +74,7 @@
7474
upload_project_file_from_stream,
7575
download_project_file,
7676
download_project_file_to_stream,
77+
delete_project_file,
7778
upload_file_from_stream,
7879
upload_file,
7980
upload_reviewable,
@@ -357,6 +358,7 @@
357358
"upload_project_file_from_stream",
358359
"download_project_file",
359360
"download_project_file_to_stream",
361+
"delete_project_file",
360362
"upload_file_from_stream",
361363
"upload_file",
362364
"upload_reviewable",

ayon_api/_api.py

Lines changed: 30 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -999,6 +999,8 @@ def upload_project_file(
999999
*,
10001000
content_type: Optional[str] = None,
10011001
filename: Optional[str] = None,
1002+
file_id: Optional[str] = None,
1003+
activity_id: Optional[str] = None,
10021004
chunk_size: Optional[int] = None,
10031005
progress: Optional[TransferProgress] = None,
10041006
) -> requests.Response:
@@ -1014,6 +1016,8 @@ def upload_project_file(
10141016
content_type (Optional[str]): MIME type of file.
10151017
filename (Optional[str]): Server filename, filename from filepath
10161018
is used if not passed.
1019+
file_id (Optional[str]): File id.
1020+
activity_id (Optional[str]): To which activity is file related.
10171021
chunk_size (Optional[int]): Size of chunks that are received
10181022
in single loop.
10191023
progress (Optional[TransferProgress]): Object that gives ability
@@ -1029,6 +1033,8 @@ def upload_project_file(
10291033
filepath=filepath,
10301034
content_type=content_type,
10311035
filename=filename,
1036+
file_id=file_id,
1037+
activity_id=activity_id,
10321038
chunk_size=chunk_size,
10331039
progress=progress,
10341040
)
@@ -1040,6 +1046,8 @@ def upload_project_file_from_stream(
10401046
filename: str,
10411047
*,
10421048
content_type: Optional[str] = None,
1049+
file_id: Optional[str] = None,
1050+
activity_id: Optional[str] = None,
10431051
chunk_size: Optional[int] = None,
10441052
progress: Optional[TransferProgress] = None,
10451053
) -> requests.Response:
@@ -1054,6 +1062,8 @@ def upload_project_file_from_stream(
10541062
stream (StreamType): Stream used as source for upload.
10551063
filename (str): Name of file on server.
10561064
content_type (Optional[str]): MIME type of file.
1065+
file_id (Optional[str]): File id.
1066+
activity_id (Optional[str]): To which activity is file related.
10571067
chunk_size (Optional[int]): Size of chunks that are received
10581068
in single loop.
10591069
progress (Optional[TransferProgress]): Object that gives ability
@@ -1069,6 +1079,8 @@ def upload_project_file_from_stream(
10691079
stream=stream,
10701080
filename=filename,
10711081
content_type=content_type,
1082+
file_id=file_id,
1083+
activity_id=activity_id,
10721084
chunk_size=chunk_size,
10731085
progress=progress,
10741086
)
@@ -1148,14 +1160,27 @@ def download_project_file_to_stream(
11481160
)
11491161

11501162

1163+
def delete_project_file(
1164+
project_name: str,
1165+
file_id: str,
1166+
) -> None:
1167+
"""Delete project file.
1168+
"""
1169+
con = get_server_api_connection()
1170+
return con.delete_project_file(
1171+
project_name=project_name,
1172+
file_id=file_id,
1173+
)
1174+
1175+
11511176
def upload_file_from_stream(
11521177
endpoint: str,
11531178
stream: StreamType,
11541179
progress: Optional[TransferProgress] = None,
11551180
request_type: Optional[RequestType] = None,
11561181
*,
1157-
filename: Optional[str] = None,
11581182
content_type: Optional[str] = None,
1183+
filename: Optional[str] = None,
11591184
**kwargs,
11601185
) -> requests.Response:
11611186
"""Upload file to server from bytes.
@@ -1171,8 +1196,8 @@ def upload_file_from_stream(
11711196
to track upload progress.
11721197
request_type (Optional[RequestType]): Type of request that will
11731198
be used to upload file.
1174-
filename (Optional[str]): Filename of file on server.
11751199
content_type (Optional[str]): MIME type of the file.
1200+
filename (Optional[str]): Filename of file on server.
11761201
**kwargs (Any): Additional arguments that will be passed
11771202
to request function.
11781203
@@ -1186,8 +1211,8 @@ def upload_file_from_stream(
11861211
stream=stream,
11871212
progress=progress,
11881213
request_type=request_type,
1189-
filename=filename,
11901214
content_type=content_type,
1215+
filename=filename,
11911216
**kwargs,
11921217
)
11931218

@@ -1198,8 +1223,8 @@ def upload_file(
11981223
progress: Optional[TransferProgress] = None,
11991224
request_type: Optional[RequestType] = None,
12001225
*,
1201-
filename: Optional[str] = None,
12021226
content_type: Optional[str] = None,
1227+
filename: Optional[str] = None,
12031228
**kwargs,
12041229
) -> requests.Response:
12051230
"""Upload file to server.
@@ -1230,8 +1255,8 @@ def upload_file(
12301255
filepath=filepath,
12311256
progress=progress,
12321257
request_type=request_type,
1233-
filename=filename,
12341258
content_type=content_type,
1259+
filename=filename,
12351260
**kwargs,
12361261
)
12371262

0 commit comments

Comments
 (0)