Skip to content

Commit 5328894

Browse files
sdericksonAndreyVMarkelov
sderickson
authored and
AndreyVMarkelov
committed
Spec Update 04/21/2026
Change Notes: account Namespace: Add get_photo route Add AccountPhotoGetArg, AccountPhotoGetResult structs Add AccountPhotoGetError, ThumbnailError unions Add account_id Namespace auth Namespace: Add UnauthorizedAccountIdUsageError struct Add NoPermissionError union check Namespace: Add EchoError union Update user, app routes to include EchoError error type common Namespace: Add DropboxDuration struct Remove EmailAddress, NamePart, OptionalNamePart, DisplayName, DisplayNameLegacy, NamespaceId, SharedFolderId, SessionId, LanguageCode aliases Remove RootInfo, TeamRootInfo, UserRootInfo structs Remove PathRoot, PathRootError unions file_requests Namespace: Add UpdateFileRequestDeadline union files Namespace: Add upload_session/append_batch route Add UploadSessionAppendBatchArg, UploadSessionAppendBatchArgEntry, UploadSessionAppendBatchResult structs Add UploadSessionAppendBatchEntryError, UploadSessionAppendBatchError, ThumbnailQuality, UploadSessionAppendBatchResultEntry unions Remove get_preview, properties/remove, properties/template/get, properties/template/list routes paper Namespace: Add docs/get_metadata route Add GetDocMetadataArg, PaperDocGetMetadataResult structs Add PaperDocStatus union Add rialto Namespace Add riviera Namespace sharing Namespace: Add ChangeLinkExpirationPolicy, ShareFolderErrorBaseV2, ShareFolderErrorV2, SharePathErrorBaseV2, SharePathErrorV2, SharedLinkMetadataError unions stone_cfg Namespace: Update Route struct to include disable_select_user, required_team_features, required_admin_permission, required_permission_type, limit_access_to_call_type, required_api_app_flag, permission_id Update auth pattern to support "app, team" auth type team Namespace: Add members/delete_former_member_files, team_folder/restore routes Add MembersFormerMemberArg struct Add HasDistinctMemberHomesValue, MembersDeleteFormerMemberFilesError, MembersPermanentlyDeleteFilesError, TeamFolderRestoreError unions Remove members/secondary_emails/add, members/secondary_emails/delete, members/secondary_emails/resend_verification_emails, properties/template/list, properties/template/update routes Remove AddSecondaryEmailsArg, AddSecondaryEmailsResult, DeleteSecondaryEmailsArg, DeleteSecondaryEmailsResult, ResendVerificationEmailArg, ResendVerificationEmailResult, UserDeleteEmailsResult, UserResendEmailsResult, UserSecondaryEmailsArg, UserSecondaryEmailsResult structs Remove AddSecondaryEmailResult, AddSecondaryEmailsError, DeleteSecondaryEmailResult, ResendSecondaryEmailResult, UserAddResult, UserDeleteResult, UserResendResult unions team_log Namespace: Add AddonAssignedDetails, AddonAssignedType, AddonLogInfo, AddonRemovedDetails, AddonRemovedType structs Add AiThirdPartySharingDropboxBasePolicyChangedDetails, AiThirdPartySharingDropboxBasePolicyChangedType structs Add AppleLoginChangePolicyDetails, AppleLoginChangePolicyType structs Add CaptureTeamSpacePolicyChangedDetails, CaptureTeamSpacePolicyChangedType structs Add DashAddedCommentToStackDetails, DashAddedCommentToStackType, DashAddedConnectorDetails, DashAddedConnectorType, DashAddedLinkToStackDetails, DashAddedLinkToStackType, DashAddedTeamEmailDomainAllowlistDetails, DashAddedTeamEmailDomainAllowlistType, DashAdminAddedOrgWideConnectorDetails, DashAdminAddedOrgWideConnectorType, DashAdminDisabledConnectorDetails, DashAdminDisabledConnectorType, DashAdminEnabledConnectorDetails, DashAdminEnabledConnectorType, DashAdminRemovedOrgWideConnectorDetails, DashAdminRemovedOrgWideConnectorType, DashArchivedStackDetails, DashArchivedStackType, DashChangedAudienceOfSharedLinkToStackDetails, DashChangedAudienceOfSharedLinkToStackType, DashClonedStackDetails, DashClonedStackType, DashCreatedStackDetails, DashCreatedStackType, DashDeletedCommentFromStackDetails, DashDeletedCommentFromStackType, DashDeletedStackDetails, DashDeletedStackType, DashEditedCommentInStackDetails, DashEditedCommentInStackType, DashExternalSharingPolicyChangedDetails, DashExternalSharingPolicyChangedType, DashExternalUserOpenedStackDetails, DashExternalUserOpenedStackType, DashFirstLaunchedDesktopDetails, DashFirstLaunchedDesktopType, DashFirstLaunchedExtensionDetails, DashFirstLaunchedExtensionType, DashFirstLaunchedWebStartPageDetails, DashFirstLaunchedWebStartPageType, DashOpenedSharedLinkToStackDetails, DashOpenedSharedLinkToStackType, DashOpenedStackDetails, DashOpenedStackType, DashPreviewOptOutStatusChangedDetails, DashPreviewOptOutStatusChangedType, DashRemovedConnectorDetails, DashRemovedConnectorType, DashRemovedLinkFromStackDetails, DashRemovedLinkFromStackType, DashRemovedSharedLinkToStackDetails, DashRemovedSharedLinkToStackType, DashRemovedTeamEmailDomainAllowlistDetails, DashRemovedTeamEmailDomainAllowlistType, DashRenamedStackDetails, DashRenamedStackType, DashSharedLinkToStackDetails, DashSharedLinkToStackType, DashUnarchivedStackDetails, DashUnarchivedStackType, DashViewedCompanyStackDetails, DashViewedCompanyStackType, DashViewedExternalAiActivityReportDetails, DashViewedExternalAiActivityReportType structs Add EncryptedFolderCancelTeamKeyRotationDetails, EncryptedFolderCancelTeamKeyRotationType, EncryptedFolderEnrollBackupKeyDetails, EncryptedFolderEnrollBackupKeyType, EncryptedFolderEnrollClientDetails, EncryptedFolderEnrollClientType, EncryptedFolderEnrollTeamDetails, EncryptedFolderEnrollTeamType, EncryptedFolderFinishTeamUnenrollmentDetails, EncryptedFolderFinishTeamUnenrollmentType, EncryptedFolderInitTeamKeyRotationDetails, EncryptedFolderInitTeamKeyRotationType, EncryptedFolderInitTeamUnenrollmentDetails, EncryptedFolderInitTeamUnenrollmentType, EncryptedFolderRemoveBackupKeyDetails, EncryptedFolderRemoveBackupKeyType, EncryptedFolderRotateTeamKeyDetails, EncryptedFolderRotateTeamKeyType, EncryptedFolderUnenrollClientDetails, EncryptedFolderUnenrollClientType structs Add FileRequestAutoCloseDetails, FileRequestAutoCloseType, FlexibleFileNamesPolicyChangedDetails, FlexibleFileNamesPolicyChangedType structs Add GroupExternalSharingSettingOverrideChangedDetails, GroupExternalSharingSettingOverrideChangedType, LinkSettingsLogInfo, MalwareExclusionState structs Add MemberAccessDetailsCreateReportDetails, MemberAccessDetailsCreateReportFailedDetails, MemberAccessDetailsCreateReportFailedType, MemberAccessDetailsCreateReportType structs Add MicrosoftLoginChangePolicyDetails, MicrosoftLoginChangePolicyType structs Add PasskeyAddDetails, PasskeyAddType, PasskeyLoginPolicyChangedDetails, PasskeyLoginPolicyChangedType, PasskeyRemoveDetails, PasskeyRemoveType structs Add PreviewsAiPolicyChangedDetails, PreviewsAiPolicyChangedType structs Add ProductAssignedToMemberDetails, ProductAssignedToMemberType, ProductLogInfo, ProductRemovedFromMemberDetails, ProductRemovedFromMemberType structs Add ReplayAddingPeoplePolicyChangedDetails, ReplayAddingPeoplePolicyChangedType, ReplayFileDownloadedDetails, ReplayFileDownloadedType, ReplaySharingPolicyChangedDetails, ReplaySharingPolicyChangedType, ReplayTeamProjectCreatedDetails, ReplayTeamProjectCreatedType structs Add RiscSecurityEventDetails, RiscSecurityEventType structs Add SendAndTrackFileAddedDetails, SendAndTrackFileAddedType, SendAndTrackFileRenamedDetails, SendAndTrackFileRenamedType, SendAndTrackFileUpdatedDetails, SendAndTrackFileUpdatedType, SendAndTrackLinkCreatedDetails, SendAndTrackLinkCreatedType, SendAndTrackLinkDeletedDetails, SendAndTrackLinkDeletedType, SendAndTrackLinkUpdatedDetails, SendAndTrackLinkUpdatedType, SendAndTrackLinkViewedDetails, SendAndTrackLinkViewedType, SendAndTrackPolicyChangedDetails, SendAndTrackPolicyChangedType, SendAndTrackRemovedFileAndAssociatedLinksDetails, SendAndTrackRemovedFileAndAssociatedLinksType structs Add SendExternalSharingPolicyChangedDetails, SendExternalSharingPolicyChangedType structs Add SharedFoldersCreateReportDetails, SharedFoldersCreateReportFailedDetails, SharedFoldersCreateReportFailedType, SharedFoldersCreateReportType structs Add SharedLinkDefaultPermissionsPolicyChangedDetails, SharedLinkDefaultPermissionsPolicyChangedType, SharedLinkRemoveVisitorDetails, SharedLinkRemoveVisitorType structs Add SignExternalSharingPolicyChangedDetails, SignExternalSharingPolicyChangedType structs Add SignSignatureRequestCanceledDetails, SignSignatureRequestCanceledType, SignSignatureRequestCompletedDetails, SignSignatureRequestCompletedType, SignSignatureRequestDeclinedDetails, SignSignatureRequestDeclinedType, SignSignatureRequestOpenedDetails, SignSignatureRequestOpenedType, SignSignatureRequestReminderSentDetails, SignSignatureRequestReminderSentType, SignSignatureRequestSentDetails, SignSignatureRequestSentType structs Add SignTemplateCreatedDetails, SignTemplateCreatedType, SignTemplateCreationPermissionChangedDetails, SignTemplateCreationPermissionChangedType, SignTemplateSharedDetails, SignTemplateSharedType structs Add TeamEncryptionKeyActivateKeyDetails, TeamEncryptionKeyActivateKeyType, TeamEncryptionKeyDeactivateKeyDetails, TeamEncryptionKeyDeactivateKeyType structs Add TeamFoldersCreateReportDetails, TeamFoldersCreateReportFailedDetails, TeamFoldersCreateReportFailedType, TeamFoldersCreateReportType structs Add TeamMemberStorageRequestPolicyChangedDetails, TeamMemberStorageRequestPolicyChangedType structs Add TeamStorageCreateReportDetails, TeamStorageCreateReportFailedDetails, TeamStorageCreateReportFailedType, TeamStorageCreateReportType structs Add TopLevelContentPolicyChangedDetails, TopLevelContentPolicyChangedType structs Add AiThirdPartySharingDropboxBasePolicy, AppleLoginPolicy, CaptureTeamSpacePolicy, DashConnectorStatus, DashExternalSharingPolicy, DashPreviewOptOutStatus, DashStackSharingScope, DashStackType, ExternalSharingSetting, FlexibleFileNamesPolicy, MicrosoftLoginPolicy, PasskeyLoginPolicy, PreviewsAiPolicy, ReplayAddingPeoplePolicy, ReplayLinkAccess, ReplaySharingPolicy, SendAndTrackPolicy, SendExternalSharingPolicy, SharedLinkDefaultPermissionsPolicy, SignExternalSharingPolicy, SignTemplateCreationPermissionPolicy, TeamMemberStorageRequestPolicy, TopLevelContentPolicy unions team_policies Namespace: Add DefaultLinkExpirationDaysPolicy, EnforceLinkPasswordPolicy, SharedLinkDefaultPermissionsPolicy, TopLevelContentPolicy unions users Namespace: Add DistinctMemberHomeValue, TeamSharedDropboxValue unions
1 parent c836440 commit 5328894

99 files changed

Lines changed: 12320 additions & 11485 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎account.stone‎

Lines changed: 0 additions & 49 deletions
This file was deleted.

‎account_account_photo.stone‎

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# @generated by protoc-gen-stone. DO NOT EDIT.
2+
# source: configs/proto/dropbox/proto/account/account_photo.proto
3+
namespace account
4+
5+
import account_id
6+
import common
7+
8+
9+
union PhotoSourceArg
10+
base64_data String
11+
"Image data in base64-encoded bytes."
12+
13+
example default
14+
base64_data = "SW1hZ2UgZGF0YSBpbiBiYXNlNjQtZW5jb2RlZCBieXRlcy4gTm90IGEgdmFsaWQgZXhhbXBsZS4="
15+
16+
union SetProfilePhotoError
17+
file_type_error
18+
"File cannot be set as profile photo."
19+
file_size_error
20+
"File cannot exceed 10 MB."
21+
dimension_error
22+
"Image must be larger than 128 x 128."
23+
thumbnail_error
24+
"Image could not be thumbnailed."
25+
transient_error
26+
"Temporary infrastructure failure, please retry."
27+
28+
struct SetProfilePhotoArg
29+
photo PhotoSourceArg
30+
"Image to set as the user's new profile photo."
31+
32+
example default
33+
photo = default
34+
35+
struct SetProfilePhotoResult
36+
profile_photo_url String
37+
"URL for the photo representing the user, if one is set."
38+
39+
example default
40+
profile_photo_url = "https://dl-web.dropbox.com/account_photo/get/dbaphid%3AAAHWGmIXV3sUuOmBfTz0wPsiqHUpBWvv3ZA?vers=1556069330102&size=128x128"
41+
42+
struct AccountPhotoGetArg
43+
dbx_account_id String
44+
"Encoded ID of the user. Must start either with 'dbid:' or 'dbaphid:'."
45+
size String
46+
"A string representing the size of the photo."
47+
circle_crop Boolean
48+
"True if the photo should be cropped and false otherwise."
49+
expect_account_photo Boolean
50+
"True if we expect account photo to exist."
51+
52+
example default
53+
dbx_account_id = "dbid:s0meEnc0ded1d"
54+
size = "16x16"
55+
circle_crop = false
56+
expect_account_photo = true
57+
58+
union ThumbnailError
59+
permanent_failure
60+
"Indicates permanent infrastructural failure."
61+
temporary_failure
62+
"Indicates temporary infrastructural failure."
63+
64+
union AccountPhotoGetError
65+
thumbnail_error ThumbnailError
66+
"Indicates infrastructural failure."
67+
account_photo_missing
68+
"Account photo is missing (but we did not expect it to exist)."
69+
expected_account_photo_missing
70+
"Account photo was expected to exist, but it's missing."
71+
72+
struct AccountPhotoGetResult
73+
content_type String
74+
"The data returned by get_photo."
75+
76+
example default
77+
content_type = "image/jpeg"
78+
79+
route set_profile_photo (SetProfilePhotoArg, SetProfilePhotoResult, SetProfilePhotoError)
80+
"Sets a user's profile photo."
81+
82+
attrs
83+
auth = "user"
84+
scope = "account_info.write"
85+

‎account_account_photo_block.stone‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
# @generated by protoc-gen-stone. DO NOT EDIT.
2+
# source: configs/proto/dropbox/proto/account/account_photo_block.proto
3+
namespace account
4+
5+
route get_photo (AccountPhotoGetArg, AccountPhotoGetResult, AccountPhotoGetError)
6+
"This lovely endpoint gets the account photo of a given user."
7+
8+
attrs
9+
allow_app_folder_app = true
10+
auth = "user"
11+
host = "content"
12+
scope = "account_info.read"
13+
select_admin_mode = "whole_team"
14+
style = "download"
15+

‎account_id.stone‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
namespace account_id
2+
3+
annotation_type ContainsDbidAnnotation
4+
"Annotation type should be applied to Response object fields which contain account id"
5+
6+
authorize_caller Boolean = true

async.stone renamed to async_common_async.stone

Lines changed: 7 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,31 +1,17 @@
1+
# @generated by protoc-gen-stone. DO NOT EDIT.
2+
# source: configs/proto/dropbox/proto/async_common/async.proto
13
namespace async
24

3-
#
4-
# Types for writing asynchronous API methods.
5-
#
6-
# There are two calls for each asynchronous method:
7-
# 1. A "Launch" method that (optionally) launches the asynchronous job
8-
# 2. A "Polling" method that polls for the status of the job that was launched by the first call.
9-
#
10-
# The following definitions are prefixed by "Launch" or "Poll", according to their intended use.
11-
5+
import common
126

137
alias AsyncJobId = String(min_length=1)
148

15-
16-
#
17-
# Launch
18-
#
19-
209
union_closed LaunchResultBase
2110
"Result returned by methods that launch an asynchronous job.
22-
2311
A method who may either launch an asynchronous job, or complete the request
2412
synchronously, can use this union by extending it, and adding a 'complete' field
2513
with the type of the synchronous response.
26-
2714
See :type:`LaunchEmptyResult` for an example."
28-
2915
async_job_id AsyncJobId
3016
"This response indicates that the processing is asynchronous.
3117
The string is an id that can be used to obtain the status of the asynchronous job."
@@ -36,63 +22,50 @@ union_closed LaunchResultBase
3622
union_closed LaunchEmptyResult extends LaunchResultBase
3723
"Result returned by methods that may either launch an asynchronous job or complete synchronously.
3824
Upon synchronous completion of the job, no additional information is returned."
39-
4025
complete
4126
"The job finished synchronously and successfully."
4227

4328
example complete
4429
complete = null
45-
30+
4631
example async_job_id
4732
async_job_id = "34g93hh34h04y384084"
4833

49-
#
50-
# Poll
51-
#
52-
5334
struct PollArg
5435
"Arguments for methods that poll the status of an asynchronous job."
55-
5636
async_job_id AsyncJobId
5737
"Id of the asynchronous job.
5838
This is the value of a response returned from the method that launched the job."
5939

6040
example default
6141
async_job_id = "34g93hh34h04y384084"
6242

63-
# TODO(kelkabany): Remove `error_msg` since others might want to return it
64-
# differently.
6543
union_closed PollResultBase
6644
"Result returned by methods that poll for the status of an asynchronous job.
6745
Unions that extend this union should add a 'complete' field with a type of
6846
the information returned upon job completion.
69-
70-
See :type:`PollEmptyResult` for an example."
71-
47+
See :type:`PollEmptyResult` for an example"
7248
in_progress
7349
"The asynchronous job is still in progress."
7450

75-
7651
union_closed PollEmptyResult extends PollResultBase
7752
"Result returned by methods that poll for the status of an asynchronous job.
7853
Upon completion of the job, no additional information is returned."
79-
8054
complete
8155
"The asynchronous job has completed successfully."
8256

8357
example complete
8458
complete = null
85-
59+
8660
example in_progress
8761
in_progress = null
8862

89-
9063
union PollError
9164
"Error returned by methods for polling the status of asynchronous job."
92-
9365
invalid_async_job_id
9466
"The job ID is invalid."
9567
internal_error
9668
"Something went wrong with the job on Dropbox's end. You'll need to
9769
verify that the action you were taking succeeded, and if not, try
9870
again. This should happen very rarely."
71+

0 commit comments

Comments
 (0)