Skip to content

Commit c756815

Browse files
DropboxBotScott Ericksonsderickson
authored
Automated Spec Update (#734)
* Automated Spec Update b343fc634be6702d3e58c2eaaf6cb622e8642512 Change Notes: shared_links Namespace: - Update comments Co-authored-by: Scott Erickson <[email protected]> * Bump package version Co-authored-by: DropboxBot <[email protected]> Co-authored-by: Scott Erickson <[email protected]> Co-authored-by: Scott Erickson <[email protected]>
1 parent c5b11c4 commit c756815

File tree

6 files changed

+16
-22
lines changed

6 files changed

+16
-22
lines changed

lib/routes.js

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1604,13 +1604,11 @@ routes.sharingCheckShareJobStatus = function (arg) {
16041604

16051605
/**
16061606
* Create a shared link. If a shared link already exists for the given path,
1607-
* that link is returned. Note that in the returned PathLinkMetadata, the
1608-
* PathLinkMetadata.url field is the shortened URL if
1609-
* CreateSharedLinkArg.short_url argument is set to true. Previously, it was
1610-
* technically possible to break a shared link by moving or renaming the
1611-
* corresponding file or folder. In the future, this will no longer be the case,
1612-
* so your app shouldn't rely on this behavior. Instead, if your app needs to
1613-
* revoke a shared link, use revoke_shared_link.
1607+
* that link is returned. Previously, it was technically possible to break a
1608+
* shared link by moving or renaming the corresponding file or folder. In the
1609+
* future, this will no longer be the case, so your app shouldn't rely on this
1610+
* behavior. Instead, if your app needs to revoke a shared link, use
1611+
* revoke_shared_link.
16141612
* @function Dropbox#sharingCreateSharedLink
16151613
* @deprecated
16161614
* @arg {SharingCreateSharedLinkArg} arg - The request parameters.
@@ -1687,8 +1685,7 @@ routes.sharingGetSharedLinkMetadata = function (arg) {
16871685
* links. If no path is given, returns a list of all shared links for the
16881686
* current user, including collection links, up to a maximum of 1000 links. If a
16891687
* non-empty path is given, returns a list of all shared links that allow access
1690-
* to the given path. Collection links are never returned in this case. Note
1691-
* that the url field in the response is never the shortened URL.
1688+
* to the given path. Collection links are never returned in this case.
16921689
* @function Dropbox#sharingGetSharedLinks
16931690
* @deprecated
16941691
* @arg {SharingGetSharedLinksArg} arg - The request parameters.

lib/types.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2976,7 +2976,7 @@ subtypes.
29762976
/**
29772977
* @typedef {Object} SharingCreateSharedLinkArg
29782978
* @property {string} path - The path to share.
2979-
* @property {boolean} short_url - Whether to return a shortened URL.
2979+
* @property {boolean} short_url
29802980
* @property {SharingPendingUploadMode} [pending_upload] - If it's okay to share
29812981
* a path that does not yet exist, set this to either PendingUploadMode.file or
29822982
* PendingUploadMode.folder to indicate whether to assume it's a file or folder.

package-lock.json

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "dropbox",
3-
"version": "10.4.2",
3+
"version": "10.4.3",
44
"registry": "npm",
55
"description": "The Dropbox JavaScript SDK is a lightweight, promise based interface to the Dropbox v2 API that works in both nodejs and browser environments.",
66
"main": "cjs/index.js",

types/index.d.ts

Lines changed: 6 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1755,13 +1755,11 @@ export class Dropbox {
17551755

17561756
/**
17571757
* Create a shared link. If a shared link already exists for the given path,
1758-
* that link is returned. Note that in the returned PathLinkMetadata, the
1759-
* PathLinkMetadata.url field is the shortened URL if
1760-
* CreateSharedLinkArg.short_url argument is set to true. Previously, it was
1761-
* technically possible to break a shared link by moving or renaming the
1762-
* corresponding file or folder. In the future, this will no longer be the
1763-
* case, so your app shouldn't rely on this behavior. Instead, if your app
1764-
* needs to revoke a shared link, use revokeSharedLink().
1758+
* that link is returned. Previously, it was technically possible to break a
1759+
* shared link by moving or renaming the corresponding file or folder. In
1760+
* the future, this will no longer be the case, so your app shouldn't rely
1761+
* on this behavior. Instead, if your app needs to revoke a shared link, use
1762+
* revokeSharedLink().
17651763
*
17661764
* When an error occurs, the route rejects the promise with type
17671765
* DropboxResponseError<sharing.CreateSharedLinkError>.
@@ -1833,8 +1831,7 @@ export class Dropbox {
18331831
* for the current user, including collection links, up to a maximum of 1000
18341832
* links. If a non-empty path is given, returns a list of all shared links
18351833
* that allow access to the given path. Collection links are never returned
1836-
* in this case. Note that the url field in the response is never the
1837-
* shortened URL.
1834+
* in this case.
18381835
*
18391836
* When an error occurs, the route rejects the promise with type
18401837
* DropboxResponseError<sharing.GetSharedLinksError>.

0 commit comments

Comments
 (0)