Skip to content

Commit d43704e

Browse files
Automated Spec Update (#590)
e733a5105a817d9a93e5c0f16f39d467d3e2072c Automated update of the API specification Co-authored-by: dropbox-sdk-updater[bot] <306210582+dropbox-sdk-updater[bot]@users.noreply.github.com> Co-authored-by: dropbox-spec-updater[bot] <306253022+dropbox-spec-updater[bot]@users.noreply.github.com>
1 parent 0d4e65d commit d43704e

3 files changed

Lines changed: 29 additions & 14 deletions

File tree

‎dropbox/base.py‎

Lines changed: 20 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -966,7 +966,9 @@ def files_alpha_upload(
966966
:param bytes f: Contents to upload.
967967
:param content_hash: A hash of the file content uploaded in this call.
968968
If provided and the uploaded content does not match this hash, an
969-
error will be returned. For more information see our `Content hash
969+
error will be returned. Optional, but recommended to avoid
970+
committing data corrupted in transit. For more information see our
971+
`Content hash
970972
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
971973
:type content_hash: Nullable[str]
972974
:rtype: :class:`dropbox.files.FileMetadata`
@@ -3298,7 +3300,9 @@ def files_upload(
32983300
:param bytes f: Contents to upload.
32993301
:param content_hash: A hash of the file content uploaded in this call.
33003302
If provided and the uploaded content does not match this hash, an
3301-
error will be returned. For more information see our `Content hash
3303+
error will be returned. Optional, but recommended to avoid
3304+
committing data corrupted in transit. For more information see our
3305+
`Content hash
33023306
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
33033307
:type content_hash: Nullable[str]
33043308
:rtype: :class:`dropbox.files.FileMetadata`
@@ -3389,7 +3393,9 @@ def files_upload_session_append_v2(self, f, cursor, close=False, content_hash=No
33893393
:type close: bool
33903394
:param content_hash: A hash of the file content uploaded in this call.
33913395
If provided and the uploaded content does not match this hash, an
3392-
error will be returned. For more information see our `Content hash
3396+
error will be returned. Optional, but recommended to avoid
3397+
committing data corrupted in transit. For more information see our
3398+
`Content hash
33933399
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
33943400
:type content_hash: Nullable[str]
33953401
:rtype: None
@@ -3427,10 +3433,11 @@ def files_upload_session_append_batch(self, f, entries, content_hash=None):
34273433
:param bytes f: Contents to upload.
34283434
:param entries: Append information for each file in the batch.
34293435
:type entries: List[:class:`dropbox.files.UploadSessionAppendBatchArgEntry`]
3430-
:param content_hash: A hash of the entire request body which is all the
3431-
concatenated pieces of file content that were uploaded in this call.
3432-
If provided and the uploaded content does not match this hash, an
3433-
error will be returned. For more information see our `Content hash
3436+
:param content_hash: A single hash of all the concatenated file contents
3437+
uploaded in this call. If provided and the uploaded content does not
3438+
match this hash, an error will be returned. Optional, but
3439+
recommended to avoid committing data corrupted in transit. For more
3440+
information see our `Content hash
34343441
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
34353442
:type content_hash: Nullable[str]
34363443
:rtype: :class:`dropbox.files.UploadSessionAppendBatchResult`
@@ -3470,7 +3477,9 @@ def files_upload_session_finish(self, f, cursor, commit, content_hash=None):
34703477
:type commit: :class:`dropbox.files.CommitInfo`
34713478
:param content_hash: A hash of the file content uploaded in this call.
34723479
If provided and the uploaded content does not match this hash, an
3473-
error will be returned. For more information see our `Content hash
3480+
error will be returned. Optional, but recommended to avoid
3481+
committing data corrupted in transit. For more information see our
3482+
`Content hash
34743483
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
34753484
:type content_hash: Nullable[str]
34763485
:rtype: :class:`dropbox.files.FileMetadata`
@@ -3652,7 +3661,9 @@ def files_upload_session_start(self, f, close=False, session_type=None, content_
36523661
:type session_type: Nullable[:class:`dropbox.files.UploadSessionType`]
36533662
:param content_hash: A hash of the file content uploaded in this call.
36543663
If provided and the uploaded content does not match this hash, an
3655-
error will be returned. For more information see our `Content hash
3664+
error will be returned. Optional, but recommended to avoid
3665+
committing data corrupted in transit. For more information see our
3666+
`Content hash
36563667
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
36573668
:type content_hash: Nullable[str]
36583669
:rtype: :class:`dropbox.files.UploadSessionStartResult`

‎dropbox/files.py‎

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10181,6 +10181,7 @@ class UploadArg(CommitInfo):
1018110181
:ivar UploadArg.content_hash:
1018210182
A hash of the file content uploaded in this call. If provided and the
1018310183
uploaded content does not match this hash, an error will be returned.
10184+
Optional, but recommended to avoid committing data corrupted in transit.
1018410185
For more information see our `Content hash
1018510186
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
1018610187
"""
@@ -10366,6 +10367,7 @@ class UploadSessionAppendArg(bb.Struct):
1036610367
:ivar UploadSessionAppendArg.content_hash:
1036710368
A hash of the file content uploaded in this call. If provided and the
1036810369
uploaded content does not match this hash, an error will be returned.
10370+
Optional, but recommended to avoid committing data corrupted in transit.
1036910371
For more information see our `Content hash
1037010372
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
1037110373
"""
@@ -10412,10 +10414,10 @@ class UploadSessionAppendBatchArg(bb.Struct):
1041210414
:ivar UploadSessionAppendBatchArg.entries:
1041310415
Append information for each file in the batch.
1041410416
:ivar UploadSessionAppendBatchArg.content_hash:
10415-
A hash of the entire request body which is all the concatenated pieces
10416-
of file content that were uploaded in this call. If provided and the
10417-
uploaded content does not match this hash, an error will be returned.
10418-
For more information see our `Content hash
10417+
A single hash of all the concatenated file contents uploaded in this
10418+
call. If provided and the uploaded content does not match this hash, an
10419+
error will be returned. Optional, but recommended to avoid committing
10420+
data corrupted in transit. For more information see our `Content hash
1041910421
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
1042010422
"""
1042110423

@@ -11000,6 +11002,7 @@ class UploadSessionFinishArg(bb.Struct):
1100011002
:ivar UploadSessionFinishArg.content_hash:
1100111003
A hash of the file content uploaded in this call. If provided and the
1100211004
uploaded content does not match this hash, an error will be returned.
11005+
Optional, but recommended to avoid committing data corrupted in transit.
1100311006
For more information see our `Content hash
1100411007
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
1100511008
"""
@@ -11732,6 +11735,7 @@ class UploadSessionStartArg(bb.Struct):
1173211735
:ivar UploadSessionStartArg.content_hash:
1173311736
A hash of the file content uploaded in this call. If provided and the
1173411737
uploaded content does not match this hash, an error will be returned.
11738+
Optional, but recommended to avoid committing data corrupted in transit.
1173511739
For more information see our `Content hash
1173611740
<https://www.dropbox.com/developers/reference/content-hash>`_ page.
1173711741
"""

‎spec‎

Submodule spec updated 1 file

0 commit comments

Comments
 (0)