@@ -12,7 +12,7 @@ alias PathOrId = String(pattern="/(.|[\\r\\n])*|id:.*")
12
12
alias PathR = String(pattern="(/(.|[\\r\\n])*)?") # A path that can be the root path ("").
13
13
alias Rev = String(min_length=9, pattern="[0-9a-f]+") # TODO: Change pattern to "rev:[0-9a-f]{9,}"
14
14
alias ListFolderCursor = String(min_length=1)
15
- alias ReadPath = String(pattern="(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})")
15
+ alias ReadPath = String(pattern="(/(.|[\\r\\n])*|id:.*)|(rev:[0-9a-f]{9,})|(ns:[0-9]+(/.*)?) ")
16
16
17
17
#
18
18
# Metadata definitions and route
@@ -29,14 +29,15 @@ struct Metadata
29
29
name String
30
30
"The last component of the path (including extension).
31
31
This never contains a slash."
32
- path_lower String
33
- "The lowercased full path in the user's Dropbox.
34
- This always starts with a slash ."
35
- path_display String
32
+ path_lower String?
33
+ "The lowercased full path in the user's Dropbox. This always starts with a slash.
34
+ This field will be null if the file or folder is not mounted ."
35
+ path_display String?
36
36
"The cased path to be used for display purposes only. In rare instances
37
37
the casing will not correctly match the user's filesystem, but this
38
38
behavior will match the path provided in the Core API v1.
39
- Changes to the casing of paths won't be returned by :route:`list_folder/continue`"
39
+ Changes to the casing of paths won't be returned by :route:`list_folder/continue`.
40
+ This field will be null if the file or folder is not mounted."
40
41
parent_shared_folder_id common.SharedFolderId?
41
42
"Deprecated. Please use :field:`FileSharingInfo.parent_shared_folder_id`
42
43
or :field:`FolderSharingInfo.parent_shared_folder_id` instead."
@@ -260,6 +261,9 @@ route get_metadata (GetMetadataArg, Metadata, GetMetadataError)
260
261
261
262
Note: Metadata for the root folder is unsupported."
262
263
264
+ attrs
265
+ owner = "dev-plat"
266
+
263
267
#
264
268
# List folder routes
265
269
#
@@ -306,8 +310,9 @@ route list_folder/longpoll (ListFolderLongpollArg, ListFolderLongpollResult, Lis
306
310
check out our
307
311
:link:`webhooks documentation https://www.dropbox.com/developers/reference/webhooks`."
308
312
attrs
309
- host="notify"
310
- auth="noauth"
313
+ host = "notify"
314
+ auth = "noauth"
315
+ owner = "dev-plat"
311
316
312
317
struct ListFolderArg
313
318
path PathR
@@ -369,6 +374,9 @@ route list_folder/continue (ListFolderContinueArg, ListFolderResult, ListFolderC
369
374
"Once a cursor has been retrieved from :route:`list_folder`, use this to
370
375
paginate through all files and retrieve updates to the folder."
371
376
377
+ attrs
378
+ owner = "dev-plat"
379
+
372
380
struct ListFolderGetLatestCursorResult
373
381
cursor ListFolderCursor
374
382
"Pass the cursor into :route:`list_folder/continue` to see what's
@@ -383,6 +391,9 @@ route list_folder/get_latest_cursor (ListFolderArg, ListFolderGetLatestCursorRes
383
391
which only needs to know about new files and modifications and doesn't need to know about
384
392
files that already exist in Dropbox."
385
393
394
+ attrs
395
+ owner = "dev-plat"
396
+
386
397
#
387
398
# Download
388
399
#
@@ -411,8 +422,9 @@ route download (DownloadArg, FileMetadata, DownloadError)
411
422
"Download a file from a user's Dropbox."
412
423
413
424
attrs
414
- host="content"
415
- style="download"
425
+ host = "content"
426
+ style = "download"
427
+ owner = "dev-plat"
416
428
417
429
#
418
430
# Upload Routes
@@ -467,16 +479,17 @@ union UploadSessionFinishError
467
479
468
480
struct UploadSessionStartArg
469
481
close Boolean = false
470
- "If true, current session will be closed. You cannot do
471
- :route:`upload_session/append` any more to current session"
482
+ "If true, the current session will be closed, at which point
483
+ you won't be able to call :route:`upload_session/append_v2`
484
+ anymore with the current session."
472
485
473
486
example with_close
474
487
close = true
475
488
476
489
struct UploadSessionStartResult
477
490
session_id String
478
491
"A unique identifier for the upload session. Pass this to
479
- :route:`upload_session/append ` and
492
+ :route:`upload_session/append_v2 ` and
480
493
:route:`upload_session/finish`."
481
494
482
495
example default
@@ -485,21 +498,23 @@ struct UploadSessionStartResult
485
498
route upload_session/start (UploadSessionStartArg, UploadSessionStartResult, Void)
486
499
"Upload sessions allow you to upload a single file using multiple requests.
487
500
This call starts a new upload session with the given data. You can
488
- then use :route:`upload_session/append ` to add more data and
501
+ then use :route:`upload_session/append_v2 ` to add more data and
489
502
:route:`upload_session/finish` to save all the data to a file in Dropbox.
490
503
491
504
A single request should not upload more than 150 MB of file contents."
492
505
493
506
attrs
494
- host="content"
495
- style="upload"
507
+ host = "content"
508
+ style = "upload"
509
+ owner = "dev-plat"
496
510
497
511
struct UploadSessionAppendArg
498
512
cursor UploadSessionCursor
499
513
"Contains the upload session ID and the offset."
500
514
close Boolean = false
501
- "If true, current session will be closed. You cannot do
502
- :route:`upload_session/append` any more to current session"
515
+ "If true, the current session will be closed, at which point
516
+ you won't be able to call :route:`upload_session/append_v2`
517
+ anymore with the current session."
503
518
504
519
example default
505
520
cursor = default
@@ -512,8 +527,9 @@ route upload_session/append_v2 (UploadSessionAppendArg, Void, UploadSessionLooku
512
527
A single request should not upload more than 150 MB of file contents."
513
528
514
529
attrs
515
- host="content"
516
- style="upload"
530
+ host = "content"
531
+ style = "upload"
532
+ owner = "dev-plat"
517
533
518
534
519
535
struct UploadSessionCursor
@@ -534,8 +550,9 @@ route upload_session/append (UploadSessionCursor, Void, UploadSessionLookupError
534
550
A single request should not upload more than 150 MB of file contents."
535
551
536
552
attrs
537
- host="content"
538
- style="upload"
553
+ host = "content"
554
+ style = "upload"
555
+ owner = "dev-plat"
539
556
540
557
union WriteMode
541
558
"Your intent when writing a file to some path. This is used to determine
@@ -623,8 +640,9 @@ route upload_session/finish (UploadSessionFinishArg, FileMetadata, UploadSession
623
640
A single request should not upload more than 150 MB of file contents."
624
641
625
642
attrs
626
- host="content"
627
- style="upload"
643
+ host = "content"
644
+ style = "upload"
645
+ owner = "dev-plat"
628
646
629
647
route upload (CommitInfo, FileMetadata, UploadError)
630
648
"Create a new file with the contents provided in the request.
@@ -633,8 +651,9 @@ route upload (CommitInfo, FileMetadata, UploadError)
633
651
upload session with :route:`upload_session/start`."
634
652
635
653
attrs
636
- host="content"
637
- style="upload"
654
+ host = "content"
655
+ style = "upload"
656
+ owner = "dev-plat"
638
657
639
658
#
640
659
# Search
@@ -727,6 +746,9 @@ route search (SearchArg, SearchResult, SearchError)
727
746
728
747
Note: Recent changes may not immediately be reflected in search results due to a short delay in indexing."
729
748
749
+ attrs
750
+ owner = "dev-plat"
751
+
730
752
#
731
753
# Errors shared by various operations
732
754
#
@@ -784,6 +806,9 @@ union CreateFolderError
784
806
route create_folder (CreateFolderArg, FolderMetadata, CreateFolderError)
785
807
"Create a folder at a given path."
786
808
809
+ attrs
810
+ owner = "dev-plat"
811
+
787
812
#
788
813
# Delete
789
814
#
@@ -809,6 +834,9 @@ route delete (DeleteArg, Metadata, DeleteError)
809
834
be the corresponding :type:`FileMetadata` or :type:`FolderMetadata` for the item at time of
810
835
deletion, and not a :type:`DeletedMetadata` object."
811
836
837
+ attrs
838
+ owner = "dev-plat"
839
+
812
840
route permanently_delete (DeleteArg, Void, DeleteError)
813
841
"Permanently delete the file or folder at a given path
814
842
(see https://www.dropbox.com/en/help/40).
@@ -855,6 +883,9 @@ route copy (RelocationArg, Metadata, RelocationError)
855
883
856
884
If the source path is a folder all its contents will be copied."
857
885
886
+ attrs
887
+ owner = "dev-plat"
888
+
858
889
#
859
890
# Move
860
891
#
@@ -864,6 +895,9 @@ route move (RelocationArg, Metadata, RelocationError)
864
895
865
896
If the source path is a folder all its contents will be moved."
866
897
898
+ attrs
899
+ owner = "dev-plat"
900
+
867
901
#
868
902
# Thumbnail
869
903
#
@@ -924,8 +958,9 @@ route get_thumbnail(ThumbnailArg, FileMetadata, ThumbnailError)
924
958
in size won't be converted to a thumbnail."
925
959
926
960
attrs
927
- host="content"
928
- style="download"
961
+ host = "content"
962
+ style = "download"
963
+ owner = "dev-plat"
929
964
930
965
#
931
966
# Preview
@@ -963,8 +998,9 @@ route get_preview(PreviewArg, FileMetadata, PreviewError)
963
998
.xls, .xlsx, .xlsm, .rtf"
964
999
965
1000
attrs
966
- host="content"
967
- style="download"
1001
+ host = "content"
1002
+ style = "download"
1003
+ owner = "dev-plat"
968
1004
969
1005
#
970
1006
# List revisions
@@ -1000,6 +1036,9 @@ struct ListRevisionsResult
1000
1036
route list_revisions(ListRevisionsArg, ListRevisionsResult, ListRevisionsError)
1001
1037
"Return revisions of a file"
1002
1038
1039
+ attrs
1040
+ owner = "dev-plat"
1041
+
1003
1042
#
1004
1043
# Restore
1005
1044
#
@@ -1027,6 +1066,9 @@ union RestoreError
1027
1066
route restore(RestoreArg, FileMetadata, RestoreError)
1028
1067
"Restore a file to a specific revision"
1029
1068
1069
+ attrs
1070
+ owner = "dev-plat"
1071
+
1030
1072
#
1031
1073
# Temporary link
1032
1074
#
@@ -1058,6 +1100,8 @@ route get_temporary_link(GetTemporaryLinkArg, GetTemporaryLinkResult, GetTempora
1058
1100
afterwards you will get 410 Gone. Content-Type of the link is determined automatically by
1059
1101
the file's mime type."
1060
1102
1103
+ attrs
1104
+ owner = "dev-plat"
1061
1105
1062
1106
#
1063
1107
# Copy reference
@@ -1093,6 +1137,9 @@ route copy_reference/get(GetCopyReferenceArg, GetCopyReferenceResult, GetCopyRef
1093
1137
save that file or folder to another user's Dropbox by passing it to
1094
1138
:route:`copy_reference/save`."
1095
1139
1140
+ attrs
1141
+ owner = "dev-plat"
1142
+
1096
1143
struct SaveCopyReferenceArg
1097
1144
copy_reference String
1098
1145
"A copy reference returned by :route:`copy_reference/get`."
@@ -1116,7 +1163,9 @@ union SaveCopyReferenceError
1116
1163
invalid_copy_reference
1117
1164
"The copy reference is invalid."
1118
1165
no_permission
1119
- "The app has no permission to access another user's Dropbox."
1166
+ "You don't have permission to save the given copy reference. Please make sure this app
1167
+ is same app which created the copy reference and the source user is still linked to
1168
+ the app."
1120
1169
not_found
1121
1170
"The file referenced by the copy reference cannot be found."
1122
1171
too_many_files
@@ -1126,6 +1175,9 @@ union SaveCopyReferenceError
1126
1175
route copy_reference/save(SaveCopyReferenceArg, SaveCopyReferenceResult, SaveCopyReferenceError)
1127
1176
"Save a copy reference returned by :route:`copy_reference/get` to the user's Dropbox."
1128
1177
1178
+ attrs
1179
+ owner = "dev-plat"
1180
+
1129
1181
#
1130
1182
# Save URL
1131
1183
#
@@ -1158,6 +1210,9 @@ route save_url(SaveUrlArg, SaveUrlResult, SaveUrlError)
1158
1210
"Save a specified URL into a file in user's Dropbox. If the given path already
1159
1211
exists, the file will be renamed to avoid the conflict (e.g. myfile (1).txt)."
1160
1212
1213
+ attrs
1214
+ owner = "dev-plat"
1215
+
1161
1216
#
1162
1217
# Save URL Job
1163
1218
#
@@ -1170,3 +1225,5 @@ union SaveUrlJobStatus extends async.PollResultBase
1170
1225
route save_url/check_job_status(async.PollArg, SaveUrlJobStatus, async.PollError)
1171
1226
"Check the status of a :route:`save_url` job."
1172
1227
1228
+ attrs
1229
+ owner = "dev-plat"
0 commit comments