Skip to content
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

Jump to bottom

chore: Update .codegen.json with commit hash of codegen and openapi spec #256

Closed
wants to merge 8 commits into from
Closed

chore: Update .codegen.json with commit hash of codegen and openapi spec #256

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
ea05270
docs: remove redundant headings (box/box-openapi#442)
box-sdk-build Jul 30, 2024
131a9bf
docs: Fix docs for python (box/box-codegen#540)
box-sdk-build Jul 31, 2024
2d38702
chore: Update .codegen.json with commit hash of codegen and openapi spec
box-sdk-build Aug 1, 2024
ea54a62
feat(ts): add comments to properties and methods (box/box-codegen#537)
box-sdk-build Aug 2, 2024
63d94ea
chore: Update .codegen.json with commit hash of codegen and openapi spec
box-sdk-build Aug 6, 2024
f8e91bc
feat: parametrise chunked uploads endpoint urls (box/box-openapi#444)
box-sdk-build Aug 7, 2024
0125443
chore: Update .codegen.json with commit hash of codegen and openapi spec
box-sdk-build Aug 8, 2024
0506346
Auto resolve conflict by keeping our changes
Aug 12, 2024
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
2 changes: 1 addition & 1 deletion .codegen.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{ "engineHash": "f42fdb0", "specHash": "e50af18", "version": "1.2.0" }
{ "engineHash": "87c9e35", "specHash": "9919482", "version": "1.2.0" }
46 changes: 31 additions & 15 deletions box_sdk_gen/managers/chunked_uploads.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@ def get_file_upload_session_by_id(
) -> UploadSession:
"""
Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
:type upload_session_id: str
Expand All @@ -210,8 +213,7 @@ def get_file_upload_session_by_id(
response: FetchResponse = fetch(
''.join(
[
self.network_session.base_urls.upload_url,
'/2.0/files/upload_sessions/',
'https://{box-upload-server}/api/2.0/files/upload_sessions/',
to_string(upload_session_id),
]
),
Expand All @@ -235,7 +237,13 @@ def upload_file_part(
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> UploadedPart:
"""
Updates a chunk of an upload session for a file.
Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
:type upload_session_id: str
Expand Down Expand Up @@ -282,8 +290,7 @@ def upload_file_part(
response: FetchResponse = fetch(
''.join(
[
self.network_session.base_urls.upload_url,
'/2.0/files/upload_sessions/',
'https://{box-upload-server}/api/2.0/files/upload_sessions/',
to_string(upload_session_id),
]
),
Expand All @@ -310,6 +317,12 @@ def delete_file_upload_session_by_id(

This cannot be reversed.


The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)


and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
:type upload_session_id: str
Expand All @@ -322,8 +335,7 @@ def delete_file_upload_session_by_id(
response: FetchResponse = fetch(
''.join(
[
self.network_session.base_urls.upload_url,
'/2.0/files/upload_sessions/',
'https://{box-upload-server}/api/2.0/files/upload_sessions/',
to_string(upload_session_id),
]
),
Expand All @@ -346,9 +358,12 @@ def get_file_upload_session_parts(
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> UploadParts:
"""
Return a list of the chunks uploaded to the upload
Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)


session so far.
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand All @@ -373,8 +388,7 @@ def get_file_upload_session_parts(
response: FetchResponse = fetch(
''.join(
[
self.network_session.base_urls.upload_url,
'/2.0/files/upload_sessions/',
'https://{box-upload-server}/api/2.0/files/upload_sessions/',
to_string(upload_session_id),
'/parts',
]
Expand All @@ -401,9 +415,12 @@ def create_file_upload_session_commit(
extra_headers: Optional[Dict[str, Optional[str]]] = None
) -> Files:
"""
Close an upload session and create a file from the
Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)

uploaded chunks.

and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

:param upload_session_id: The ID of the upload session.
Example: "D5E3F7A"
Expand Down Expand Up @@ -450,8 +467,7 @@ def create_file_upload_session_commit(
response: FetchResponse = fetch(
''.join(
[
self.network_session.base_urls.upload_url,
'/2.0/files/upload_sessions/',
'https://{box-upload-server}/api/2.0/files/upload_sessions/',
to_string(upload_session_id),
'/commit',
]
Expand Down
22 changes: 17 additions & 5 deletions docs/chunked_uploads.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,6 +75,8 @@ Returns a new upload session.

Return information about an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions) endpoint.

This operation is performed by calling function `get_file_upload_session_by_id`.

See the endpoint docs at
Expand All @@ -97,7 +99,10 @@ Returns an upload session object.

## Upload part of file

Updates a chunk of an upload session for a file.
Uploads a chunk of a file for an upload session.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

This operation is performed by calling function `upload_file_part`.

Expand Down Expand Up @@ -140,6 +145,9 @@ Abort an upload session and discard all data uploaded.

This cannot be reversed.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

This operation is performed by calling function `delete_file_upload_session_by_id`.

See the endpoint docs at
Expand All @@ -163,8 +171,10 @@ successfully aborted.

## List parts

Return a list of the chunks uploaded to the upload
session so far.
Return a list of the chunks uploaded to the upload session so far.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

This operation is performed by calling function `get_file_upload_session_parts`.

Expand Down Expand Up @@ -196,8 +206,10 @@ Returns a list of parts that have been uploaded.

## Commit upload session

Close an upload session and create a file from the
uploaded chunks.
Close an upload session and create a file from the uploaded chunks.

The actual endpoint URL is returned by the [`Create upload session`](e://post-files-upload-sessions)
and [`Get upload session`](e://get-files-upload-sessions-id) endpoints.

This operation is performed by calling function `create_file_upload_session_commit`.

Expand Down
Loading