nextcloud
/
bookmarks
mirror of https://github.com/nextcloud/bookmarks
0
0
Fork 0
Code Issues Releases Wiki Activity

Update docs

This commit is contained in:
Marcel Klehr 2019-11-23 13:34:26 +01:00
parent 0455134303
commit f741d87a87
1 changed files with 0 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
docs/bookmark.rst
View File

@ -33,7 +33,6 @@ Query bookmarks
:query page: if this is non-negative, results will be paginated by 10 bookmarks a page. Default: ``0``
:query sortby: The column to sort the results by; one of ``url``, ``title``, ``description``, ``public``, ``lastmodified``, ``clickcount``. Default: ``lastmodified``.
:query search[]: An array of words to search for in the following columns `url`, `title`, `description`
:query user: Instead of returning the bookmarks of the current user, return the public bookmarks of the user passed as this parameter.
:query folder: Only return bookmarks that are direct children of the folder with the passed ID. The root folder has id `-1`.
:query url: Only return bookmarks with this URL. This will only ever return just one bookmark or none, because the app doesn't store duplicates. Thus, with this parameter you can test whether a URL exists in the user's bookmarks. This parameter cannot be mixed with the others.
@ -72,7 +71,6 @@ Create a bookmark
:param id: the url of the new bookmark
:param array tags: Array of tags for this bookmark (these needn't exist and are created on-the-fly; this used to be `item[tags][]`, which is now deprecated)
:param string title: the title of the bookmark. If absent the title of the html site referenced by `url` is used
:param boolean is_public: Set this parameter (without a value) to mark the new bookmark as public, so that other users can see it
:param string description: A description for this bookmark
:param array folders: An array of IDs of the folders this bookmark should reside in.
@ -165,7 +163,6 @@ Edit a bookmark
:param id: the url of the new bookmark
:param array tags: Array of tags for this bookmark (these needn't exist and are created on-the-fly; this used to be `item[tags][]`, which is now deprecated)
:param string title: the title of the bookmark. If absent the title of the html site referenced by `url` is used
:param boolean is_public: Set this parameter (without a value) to mark the new bookmark as public, so that other users can see it
:param string description: A description for this bookmark
:param array folders: An array of IDs of the folders this bookmark should reside in.